openapi: 3.1.0
info:
  title: Chargebee API
  contact:
    name: Chargebee Support
    url: https://www.chargebee.com
    email: support@chargebee.com
  version: 2026-05-08.dd2c2397a1673d374127e2311974b61d3e84350d
  x-cb-api-version: 2
  x-cb-product-catalog-version: 1
  x-generated-on: 1778229112737
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"
paths:
  /subscriptions/{subscription-id}/remove_advance_invoice_schedule:
    post:
      summary: Remove an advance invoice schedules
      description: |
        Deletes an advance invoicing schedule. When *schedule_type = specific_dates*, you also have the option of deleting a part of the schedule.
      operationId: remove_an_advance_invoice_schedules
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for specific_dates_schedule
                  properties:
                    id:
                      type: array
                      description: |
                        When *schedule_type = specific_dates*
                        , pass the id of the [specific_dates_schedule](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule)
                        that you want to remove. If not passed, the entire advance_invoice_schedule is removed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              specific_dates_schedule:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  advance_invoice_schedules:
                    type: array
                    description: <p class="mb-2">Resource object representing advance_invoice_schedule</p>
                    items:
                      $ref: "#/components/schemas/AdvanceInvoiceSchedule"
                      description: Resource object representing advance_invoice_schedule
                    example: null
                required:
                - subscription
                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: []
  /subscriptions/{subscription-id}/remove_coupons:
    post:
      summary: Remove coupons
      description: |
        Removes Coupons associated with the Subscription. If the param 'coupon_ids' is not specified, all the Coupons linked to the Subscription will be removed.
      operationId: remove_coupons
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be removed from the subscription. You can provide only [coupon_id](/docs/api/coupons/coupon-object#id)
                    and not [coupon_code](/docs/api/coupon_codes/coupon_code-object#code)
                    .
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/resume:
    post:
      summary: Resume a subscription
      description: |
        **Note:**
        This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)
        and pass it as input parameter to this API.

        This API is used to resume a **paused** subscription. On resumption the subscription will be activated and any applicable charges will be initiated.

        You could schedule the resumption by passing **specific_date** parameter in resume_option. If scheduled, the subscription will be resumed on the **specific_date** and moved to Active state.

        For in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.

        **What is an "in-term resumption"?**
        An "in-term resumption" is when the pause and resumption happens within the billing term of the subscription.

        **Example :** A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.

        #### UNPAID INVOICES

        Specifying **unpaid_invoices** allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.

        If specified as **schedule_payment_collection**, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices.

        **Note:** If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
      operationId: resume_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                resume_option:
                  type: string
                  deprecated: false
                  description: |
                    List of options to resume the subscription.
                    \* immediately -

                    Resume immediately
                    \* specific_date -

                    Resume on a specific date
                  enum:
                  - immediately
                  - specific_date
                  example: null
                resume_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Date on which the subscription will be resumed. Applicable when **resume_option**
                    is set as 'specific_date'.
                  example: null
                charges_handling:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when charges get added during this operation and **resume_option**
                    is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.
                    \* add_to_unbilled_charges -

                    Add to unbilled charges
                    \* invoice_immediately -

                    Invoice immediately
                  enum:
                  - invoice_immediately
                  - add_to_unbilled_charges
                  example: null
                unpaid_invoices_handling:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when the subscription has past due invoices and **resume_option**
                    is set as 'immediately'. Allows to collect past due invoices or retain them as unpaid. If 'schedule_payment_collection' option is chosen in this field, remaining refundable credits and excess payments are applied.
                    **Note:**
                    The payment collection attempt will be asynchronous.
                    \* no_action -

                    Retain as unpaid
                    \* schedule_payment_collection -

                    Collect payment
                  enum:
                  - no_action
                  - schedule_payment_collection
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* payme -

                        Payments made via PayMe
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* go_pay -

                        Payments made via GoPay
                        \* pay_by_bank -

                        Pay By Bank
                        \* google_pay -

                        google_pay
                        \* apple_pay -

                        apple_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* giropay -

                        giropay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* ideal -

                        ideal
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
              example: null
            encoding:
              payment_intent:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/regenerate_invoice:
    post:
      summary: Regenerate an invoice
      description: |-
        <div class="api-description"><p class="mb-2">Regenerates the invoice for the current term of the subscription. The subscription must have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>. This operation is not allowed when any of the following conditions hold true for the subscription:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">An invoice exists for the current term and its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">voided</code>.</li>
        <li class="text-base leading-relaxed">There are <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank" rel="noopener noreferrer">unbilled charges</a> for the current term.</li>
        <li class="text-base leading-relaxed">The subscription has an <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank" rel="noopener noreferrer">advance invoice</a>.</li>
        </ul><h4>Response</h4><p class="mb-2">Returns one of the following depending on the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code> object that corresponds to the regenerated invoice.</li>
        <li class="text-base leading-relaxed">If the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: a list of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unbilled_charge</code> objects corresponding to all the unbilled charges created for the current term of the subscription.</li>
        </ul></div>
      operationId: regenerate_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The start date of the period being invoiced. The default value is [current_term_start](/docs/api/subscriptions/subscription-object#current_term_start)
                    .
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The end date of the period being invoiced. The default value is [current_term_end](/docs/api/subscriptions/subscription-object#current_term_end)
                    .
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the charges should be prorated according to the term specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_from</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_to</code>.
                    Should not be passed without <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_from</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_to</code>
                    .</p>
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Only applicable when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html " target="_blank">Consolidated Invoicing</a>
                    is enabled for the customer. Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    to leave the current term charge for the subscription as <a href="https://www.chargebee.com/docs/unbilled-charges.html " target="_blank">unbilled</a>.
                    Once you have done this for all suitable subscriptions of the customer, call <a href="/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges" target="_blank">Create an invoice for unbilled charges</a>
                    to invoice them.</p>
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                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: []
  /subscriptions:
    get:
      summary: List subscriptions
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Returns a list of subscriptions meeting <strong class="font-semibold">all</strong> the conditions specified in the filter parameters below.</p></div>
      operationId: list_subscriptions
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |-
          <p class="mb-2">Indicates whether to include deleted objects in the list. The deleted objects have the attribute <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">deleted</code>
          as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
          .</p>
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "8gsnbYfsMLds"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8gsnbYfsMLds
          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: customer_id
        in: query
        description: |
          optional, string filter

          Identifier of the customer with whom this subscription is associated.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is\] = "8gsnbYfsMLds"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8gsnbYfsMLds
          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: plan_id
        in: query
        description: |
          optional, string filter

          Identifier of the plan for this subscription.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *plan_id\[is\] = "basic"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: basic
          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: status
        in: query
        description: |
          optional, enumerated string filter

          Current state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "active"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: active
          properties:
            is:
              type: string
              description: |
                \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
              enum:
              - future
              - in_trial
              - active
              - non_renewing
              - paused
              - cancelled
              - transferred
              example: null
            is_not:
              type: string
              description: |
                \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
              enum:
              - future
              - in_trial
              - active
              - non_renewing
              - paused
              - cancelled
              - transferred
              example: null
            in:
              type: string
              description: |
                \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
              enum:
              - future
              - in_trial
              - active
              - non_renewing
              - paused
              - cancelled
              - transferred
              pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
              enum:
              - future
              - in_trial
              - active
              - non_renewing
              - paused
              - cancelled
              - transferred
              pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                ]$"
              example: null
      - name: cancel_reason
        in: query
        description: |
          optional, enumerated string filter

          The reason for canceling the subscription. Set by Chargebee automatically. Possible values are : not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer.

          **Supported operators :**
          is, is_not, in, not_in, is_present

          **Example →**
          *cancel_reason\[is\] = "not_paid"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: not_paid
          properties:
            is:
              type: string
              description: |
                \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
              enum:
              - not_paid
              - no_card
              - fraud_review_failed
              - non_compliant_eu_customer
              - tax_calculation_failed
              - currency_incompatible_with_gateway
              - non_compliant_customer
              example: null
            is_not:
              type: string
              description: |
                \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
              enum:
              - not_paid
              - no_card
              - fraud_review_failed
              - non_compliant_eu_customer
              - tax_calculation_failed
              - currency_incompatible_with_gateway
              - non_compliant_customer
              example: null
            in:
              type: string
              description: |
                \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
              enum:
              - not_paid
              - no_card
              - fraud_review_failed
              - non_compliant_eu_customer
              - tax_calculation_failed
              - currency_incompatible_with_gateway
              - non_compliant_customer
              pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
              enum:
              - not_paid
              - no_card
              - fraud_review_failed
              - non_compliant_eu_customer
              - tax_calculation_failed
              - currency_incompatible_with_gateway
              - non_compliant_customer
              pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                ]$"
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: cancel_reason_code
        in: query
        description: |
          optional, string filter

          Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** .
          Must be passed if set as mandatory in the app. The codes are case-sensitive.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *cancel_reason_code\[is_not\] = "Not Paid"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Not Paid
          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: remaining_billing_cycles
        in: query
        description: |
          optional, integer filter

          * When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
          * When the subscription is on a [contract term](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle. . **Supported operators :** is, is_not, lt, lte, gt, gte, between, is_present

          **Example →**
          *remaining_billing_cycles\[gt\] = "3"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "3"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The time at which the subscription was created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: activated_at
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">Time at which the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
          last changed to
          <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>.
          For example, this value is updated when an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
          or
          <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
          subscription activates.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between, is_present</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">activated_at[after] = &quot;1435054328&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: next_billing_at
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>
          unless multiple subscription terms were invoiced in advance using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
          parameter.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">next_billing_at[after] = &quot;1435054328&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: cancelled_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Time at which subscription was cancelled or is set to be cancelled.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *cancelled_at\[on\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: has_scheduled_changes
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn>
          <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
          , there are subscription changes scheduled on next renewal. Possible values are : <em class="italic">true, false</em></p>
          <p class="mb-2"><strong class="font-semibold">Supported operators :</strong>
          is</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">has_scheduled_changes[is] = &quot;true&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "true"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: updated_at
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
          This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
          input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
          for a faster response.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">updated_at[after] = &quot;1243545465&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: offline_payment_method
        in: query
        description: |
          optional, enumerated string filter

          The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *offline_payment_method\[is\] = "cash"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: cash
          properties:
            is:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              example: null
            is_not:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              example: null
            in:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                ]$"
              example: null
      - name: auto_close_invoices
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn>
          <p class="mb-2">Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
          to override for this subscription, the <a href="https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a>
          for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>.
          Possible values are : <em class="italic">true, false</em></p>
          <p class="mb-2"><strong class="font-semibold">Supported operators :</strong>
          is</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">auto_close_invoices[is] = &quot;true&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "true"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: override_relationship
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn>
          <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
          , ignores the <a href="/docs/api/customers/customer-object#relationship">hierarchy relationship</a>
          and uses customer as payment and invoice owner. Possible values are : <em class="italic">true, false</em></p>
          <p class="mb-2"><strong class="font-semibold">Supported operators :</strong>
          is</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">override_relationship[is] = &quot;false&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "false"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
          example: null
      - name: business_entity_id
        in: query
        description: "optional, string filter\n\nThe ID of the business entity created\
          \ for the site. For Product Catalog 1.0, all the site data is tied to this\
          \ business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started)\
          \ is a feature available only on Product Catalog 2.0.\n\n**Supported operators\
          \ :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is\\\
          ] = \"business_entity_id\"*\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: business_entity_id
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is_not\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        subscription:
                          $ref: "#/components/schemas/Subscription"
                          description: Resource object representing subscription
                        customer:
                          $ref: "#/components/schemas/Customer"
                          description: Resource object representing customer
                        card:
                          $ref: "#/components/schemas/Card"
                          description: Resource object representing card
                      required:
                      - customer
                      - subscription
                      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: []
    post:
      summary: Create a subscription
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        This operation optionally supports 3DS verification flow. To achieve the same, create the <a href="/docs/api/getting-started">Payment Intent</a>
        and pass it as input parameter to this API.</p></div><p class="mb-2">Creates a new subscription along with the customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.</p><h4>Future Subscriptions</h4><p class="mb-2">If the <strong class="font-semibold">start_date</strong> is specified, the subscription will be created in &#x27;future&#x27; state (.ie, instead of starting immediately it will be scheduled to start at the specified &#x27;start_date&#x27;). Besides if &#x27;trial&#x27; is specified (plan configuration or specified explicitly using trial_end), the subscription will go into &#x27;trial&#x27; state when it starts. Otherwise it will directly become &#x27;active&#x27; when it starts.</p><h4>Trial Period</h4><p class="mb-2">If the plan has trial period or if the trial_end is specified explicitly, the subscription will be created in &#x27;in_trial&#x27; state.</p><p class="mb-2">If the card details are passed, it is not charged until the end of the trial period. Incase you need to verify the card you could enable the <a href="https://www.chargebee.com/docs/cards.html#card-verification">&#x27;card verification option&#x27;</a> in the gateway settings.</p><h4>Invoice</h4><p class="mb-2">If the plan does not have a trial period and if any of the recurring items has charges, then a invoice would be raised immediately. If &#x27;auto_collection&#x27; is turned &#x27;on&#x27;, then card attributes are mandatory and subscription will be created only if the payment was successful.</p><h4>Card details</h4><p class="mb-2">Passing card details to this API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If you are using Stripe gateway, you can use <a href="https://stripe.com/docs/stripe.js" target="_blank">Stripe.js</a> with your checkout form. Take a look at this <a href="https://stripe.com/docs/payments/accept-a-payment-charges" target="_blank">Stripe tutorial</a> for more details.</li>
        <li class="text-base leading-relaxed">If you are using Braintree gateway, you can use <a href="https://www.braintreepayments.com/docs/javascript" target="_blank">Braintree.js</a> with your checkout form. Please refer this <a href="https://www.chargebee.com/tutorials/braintree-js-example.html" target="_blank">tutorial</a> for more details.</li>
        <li class="text-base leading-relaxed">If you are using Authorize.Net gateway, you use <a href="https://developer.authorize.net/api/reference/features/acceptjs.html" target="_blank">Accept.js</a> with your checkout form.</li>
        <li class="text-base leading-relaxed">In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s <a href="https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce" target="_blank">Client Side Encryption</a> to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
        You can also use our <a href="https://www.chargebee.com/docs/hosted_pages.html" target="_blank">Hosted Pages</a>
        based integration.</li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Legacy behavior:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">For <a href="https://www.chargebee.com/docs/sites-intro.html" target="_blank">sites</a> created before March 1st, 2014:</strong> On making this request, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> of the customer are <strong class="font-semibold">deleted</strong> and replaced by the values passed with this request. Ensure that you pass the <a href="/docs/api/v2/pcv-1/subscriptions/create-a-subscription#card_billing_addr1">billing address parameters</a> and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> parameters each time you make this request, to avoid losing the same information at the customer-level.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">For <a href="https://www.chargebee.com/docs/sites-intro.html" target="_blank">sites</a> created on or after March 1st, 2014:</strong> This request does not alter the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> of the customer.</li>
        </ul></div><h4>Related Tutorials</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <a href="https://www.chargebee.com/tutorials/custom-fields-recurring-billing-example.html" target="_blank">Check out this tutorial to create trial signup with custom fields.</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="https://www.chargebee.com/tutorials/in-app-checkout-page-using-estimate-api-example.html" target="_blank">Learn how to implement a in-app checkout flow that allows your customers to select addons and apply coupons. Estimate API is used to dynamically calculate the order summary shown to the customer.</a>
        </li>
        </ul></div>
      operationId: create_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                  maxLength: 50
                  example: null
                plan_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the plan for this subscription.
                  maxLength: 100
                  example: null
                plan_quantity:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Plan quantity for this subscription.
                  minimum: 1
                  example: null
                plan_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                plan_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Plan Unit Amount for create subscription.
                  minimum: 0
                  example: null
                plan_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    Plan Unit Amount in Decimal for create subscription.
                  maxLength: 39
                  example: null
                setup_fee:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                    is passed, the subscription will be activated immediately.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a <a href="/docs/api/v2/pcv-1/contract_terms">contract term</a> or not.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When the subscription is not on a contract term: if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> is not provided, then the billing cycles <a href="/docs/api/v2/pcv-1/plans/plan-object#billing_cycles">set for the plan</a> is used. Moreover, once the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> have completed, the subscription cancels.</li>
                    <li class="text-base leading-relaxed">When the subscription is on a contract term: Providing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> is mandatory. Moreover, once the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> have completed, the behavior of the subscription is determined by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term[action_at_term_end]</code> parameter.</li>
                    </ul>
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                  enum:
                  - "on"
                  - "off"
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                offline_payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The preferred offline payment method for the subscription.
                    \* sepa_credit -

                    SEPA Credit
                    \* cash -

                    Cash
                    \* no_preference -

                    No Preference
                    \* bank_transfer -

                    Bank Transfer
                    \* check -

                    Check
                    \* eu_automated_bank_transfer -

                    EU Automated Bank Transfer
                    \* jp_automated_bank_transfer -

                    JP Automated Bank Transfer
                    \* uk_automated_bank_transfer -

                    UK Automated Bank Transfer
                    \* custom -

                    Custom
                    \* boleto -

                    Boleto
                    \* mx_automated_bank_transfer -

                    MX Automated Bank Transfer
                    \* us_automated_bank_transfer -

                    US Automated Bank Transfer
                    \* ach_credit -

                    ACH Credit
                  enum:
                  - no_preference
                  - cash
                  - check
                  - bank_transfer
                  - ach_credit
                  - sepa_credit
                  - boleto
                  - us_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - uk_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  - custom
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase order number for this subscription.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The Chargebee payment token generated by <a href="https://www.chargebee.com/checkout-portal-docs/3ds-helper-overview.html#using-gateway-s-hosted-fields">Chargebee JS</a>.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:
                    The payment token created via Chargebee JS uses the gateway selected through <a href="https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing">Smart Routing</a>.
                    Explicitly passing a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway_id</code>
                    in this API call will not override the gateway associated with the token.</p></div>
                  maxLength: 40
                  example: null
                affiliate_token:
                  type: string
                  deprecated: false
                  description: |
                    A unique tracking token.
                  maxLength: 250
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.</li>
                    <li class="text-base leading-relaxed">It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is true.
                    .</li>
                    </ul>
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                free_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
                  minimum: 1
                  example: null
                free_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                    attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                    chosen.
                    \* week -

                    Charge based on week(s)
                    \* month -

                    Charge based on month(s)
                    \* day -

                    Charge based on day(s)
                    \* year -

                    Charge based on year(s)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
                    \* activate_subscription -

                    The subscription activates and charges are raised for non-metered items.
                    \* cancel_subscription -

                    The subscription cancels.
                    \* plan_default -

                    The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                    \* site_default -

                    This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                  enum:
                  - site_default
                  - plan_default
                  - activate_subscription
                  - cancel_subscription
                  example: null
                client_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  maxLength: 50
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique ID of the customer for which this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription</code>
                        resource should be created.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Company name of the customer.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the customer
                      maxLength: 50
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies if the customer is liable for tax</p>
                        * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                        <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                        </ul>
                        * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                        In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                      enum:
                      - taxable
                      - exempt
                      example: null
                    entity_code:
                      type: string
                      deprecated: false
                      description: |
                        The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                        \* med2 -

                        US Medical Device Excise Tax with taxable sales tax
                        \* med1 -

                        US Medical Device Excise Tax with exempt sales tax
                        \* b -

                        State government
                        \* c -

                        Tribe/Status Indian/Indian Band
                        \* a -

                        Federal government
                        \* f -

                        Religious organization
                        \* g -

                        Resale
                        \* d -

                        Foreign diplomat
                        \* e -

                        Charitable or benevolent organization
                        \* j -

                        Direct pay permit
                        \* k -

                        Direct mail
                        \* h -

                        Commercial agricultural production
                        \* i -

                        Industrial production/manufacturer
                        \* n -

                        Local government
                        \* l -

                        Other or custom
                        \* m -

                        Educational organization
                        \* r -

                        Non-resident
                        \* p -

                        Commercial aquaculture
                        \* q -

                        Commercial Fishery
                      enum:
                      - a
                      - b
                      - c
                      - d
                      - e
                      - f
                      - g
                      - h
                      - i
                      - j
                      - k
                      - l
                      - m
                      - "n"
                      - p
                      - q
                      - r
                      - med1
                      - med2
                      example: null
                    exempt_number:
                      type: string
                      deprecated: false
                      description: |
                        Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                      maxLength: 100
                      example: null
                    net_term_days:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days within which the customer has to make payment for the invoice.
                      example: null
                    taxjar_exemption_category:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration.
                        \* wholesale -

                        Whole-sale
                        \* other -

                        Other
                        \* government -

                        Government
                      enum:
                      - wholesale
                      - government
                      - other
                      example: null
                    auto_collection:
                      type: string
                      default: "on"
                      deprecated: false
                      description: |
                        Whether payments needs to be collected automatically for this customer
                        \* on -

                        Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
                        \* off -

                        Automatic collection of charges will not be made. All payments must be recorded offline.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* check -

                        Check
                        \* bank_transfer -

                        Bank Transfer
                        \* custom -

                        Custom
                        \* cash -

                        Cash
                        \* no_preference -

                        No Preference
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* sepa_credit -

                        SEPA Credit
                        \* ach_credit -

                        ACH Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    allow_direct_debit:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether the customer can pay via Direct Debit
                      example: null
                    consolidated_invoicing:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                        of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                        is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                        is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                        See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      maxLength: 50
                      example: null
                    entity_identifier_standard:
                      type: string
                      default: iso6523-actorid-upis
                      deprecated: false
                      description: |-
                        <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
                        Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                        is supported and is used by default when not provided.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      maxLength: 50
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>
                        ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        , the customer is not e-invoiced even if e-invoicing is enabled for their country.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      example: null
                    einvoicing_method:
                      type: string
                      deprecated: false
                      description: |
                        Determines whether to send einvoice manually or automatic.
                        \* automatic -

                        Use this value to send e-invoice every time an invoice or credit note is created.
                        \* manual -

                        When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
                        \* site_default -

                        The default value of the site which can be overridden at the customer level.
                      enum:
                      - automatic
                      - manual
                      - site_default
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                    business_customer_without_vat_number:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is a valid business without an EU/UK VAT number.
                      example: null
                    exemption_details:
                      type: array
                      deprecated: false
                      description: |
                        Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                        To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)
                        .
                      items:
                        example: null
                      example: null
                    customer_type:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                        \* senior_citizen -

                        When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
                        \* business -

                        When the purchase is made at a place of business
                        \* residential -

                        When the purchase is made by a customer for home use
                        \* industrial -

                        When the purchase is made by an industrial business
                      enum:
                      - residential
                      - business
                      - senior_citizen
                      - industrial
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* visa -\n\nA Visa card scheme.\n\\* mada -\n\nA Mada card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                bank_account:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bank_account
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    iban:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's International Bank Account Number. For the [GoCardless](https://www.chargebee.com/docs/gocardless.html)
                        platform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
                      maxLength: 50
                      minLength: 10
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's first name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's last name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's company name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 250
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the account holder that is linked to the bank account.
                      maxLength: 50
                      example: null
                    bank_name:
                      type: string
                      deprecated: false
                      description: |
                        Name of account holder's bank.
                      maxLength: 100
                      example: null
                    account_number:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's bank account number.
                      maxLength: 17
                      minLength: 4
                      example: null
                    routing_number:
                      type: string
                      deprecated: false
                      description: |
                        Bank account routing number.
                      maxLength: 9
                      minLength: 3
                      example: null
                    bank_code:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the bank code.
                      maxLength: 20
                      example: null
                    account_type:
                      type: string
                      deprecated: false
                      description: |
                        Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/)
                        ACH and Razorpay NetBanking users only. If not passed, account type is taken as null.
                        \* checking -

                        Checking Account
                        \* business_checking -

                        Business Checking Account
                        \* savings -

                        Savings Account
                        \* current -

                        Current Account
                      enum:
                      - checking
                      - savings
                      - business_checking
                      - current
                      example: null
                    account_holder_type:
                      type: string
                      deprecated: false
                      description: |
                        For Stripe ACH users only. Indicates the account holder type.
                        \* individual -

                        Individual Account.
                        \* company -

                        Company Account.
                      enum:
                      - individual
                      - company
                      example: null
                    echeck_type:
                      type: string
                      deprecated: false
                      description: |
                        For Authorize.net ACH users only. Indicates the type of eCheck.
                        \* ppd -

                        Payment Authorization is prearranged between the customer and the merchant.
                        \* ccd -

                        Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
                        \* web -

                        Payment Authorization obtained from the customer via the internet.
                      enum:
                      - web
                      - ppd
                      - ccd
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |
                        [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)
                        ISO country code. Required when local bank details are provided, and not IBAN.
                      maxLength: 50
                      example: null
                    swedish_identity_number:
                      type: string
                      deprecated: false
                      description: |
                        For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
                      maxLength: 12
                      minLength: 10
                      example: null
                    billing_address:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address associated with the bank account. The value is a JSON object with the following keys and their values:-   <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">company_name</code>:(string, max chars=250) The company name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>:(string) The name of the country for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code>:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li>
                        </ul>
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made\
                        \ via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\
                        \nPayments made via Sofort.\n\\* twint -\n\nPayments made\
                        \ via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                        \ Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay\
                        \ -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* upi -\n\nUPI Payments.\n\\\
                        * revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments\
                        \ made via Alipay.  \nThis payment source is deprecated.\n\
                        \\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments\
                        \ made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\
                        \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                        \ -\n\nPayments made via WeChat Pay.  \nThis payment source\
                        \ is deprecated.\n\\* sepa_instant_transfer -\n\nPayments\
                        \ made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
                        \ made via Dotpay.\n\\* paypal_express_checkout -\n\nPayments\
                        \ made via PayPal Express Checkout.\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* faster_payments -\n\nPayments made via\
                        \ Faster Payments\n\\* swish -\n\nPayments made via Swish\n\
                        \\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* amazon_payments -\n\nPayments made via\
                        \ Amazon Payments.\n\\* card -\n\nCard based payment including\
                        \ credit cards and debit cards. Details about the card can\
                        \ be obtained from the card resource.\n\\* online_banking_poland\
                        \ -\n\nPayments made via Online Banking Poland\n\\* trustly\
                        \ -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\
                        \\* cash_app_pay -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet or card details. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                      maxLength: 65000
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* google_pay -

                        google_pay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* ideal -

                        ideal
                        \* boleto -

                        boleto
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* grab_pay -

                        Payments made via GrabPay
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* swish -

                        Payments made via Swish
                        \* go_pay -

                        Payments made via GoPay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* venmo -

                        Venmo
                        \* alipay -

                        Payments made via Alipay.
                        \* pay_to -

                        PayTo
                        \* pay_co -

                        Payments made via PayCo
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* online_banking_poland -

                        Online Banking Poland
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for statement_descriptor
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)
                        text configured in the Chargebee site for all the subscription renewal transactions.
                      maxLength: 65000
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                        in Chargebee. When not provided, it is autogenerated.</p>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: |-
                        <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                        of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                        is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                        is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                        See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: |-
                        <p class="mb-2">The value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>.
                        This identifies the customer entity on the Peppol network. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">10101010-STO-10</code>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    standard:
                      type: array
                      description: |-
                        <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>.
                        Currently, only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                        is supported and is used by default when not provided.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        The unique identifier belonging to a tax vendor when they are onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Addon Unit Amount for create subscription
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        Addon Unit Amount in Decimal for create subscription
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                        status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        )</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
              required:
              - plan_id
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              bank_account:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/move:
    post:
      summary: Move a subscription
      description: |-
        <div class="api-description"><p class="mb-2">Moves a subscription from one <a href="/docs/api/v2/pcv-1/customers">customer</a> to another asynchronously. All related resources such as <code><a href="/docs/api/v2/pcv-1/unbilled_charges">unbilled_charge</a></code>, <code><a href="/docs/api/v2/pcv-1/invoices">invoice</a></code>, <code><a href="/docs/api/v2/pcv-1/credit_notes">credit_note</a></code>, and <code><a href="/docs/api/v2/pcv-1/transactions">transaction</a></code> are also moved to the new customer.</p><p class="mb-2">After moving, Chargebee adds a <code><a href="/docs/api/v2/pcv-1/comments">comment</a></code> to the original <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource to document the move, including the <code><a href="/docs/api/v2/pcv-1/subscriptions/move-a-subscription#to_customer_id">to_customer_id</a></code> and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>s of all the resources transferred to the destination customer.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Warning</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If <code><a href="/docs/api/subscriptions/create-subscription-for-items">auto_collection</a></code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>, it might fail after this operation. Refer to the warning in <code><a href="/docs/api/v2/pcv-1/subscriptions/move-a-subscription#copy_payment_source">copy_payment_source</a></code> for details.</li>
        <li class="text-base leading-relaxed">During the time that it takes for the operation to complete, no modifications are allowed on the source customer, the destination customer, and the subscription.</li>
        <li class="text-base leading-relaxed">After moving a subscription, the change does not reflect in Chargebee Billing&#x27;s <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html" target="_blank">accounting integrations</a> or in <a href="https://www.chargebee.com/docs/revrec/chargebee-billing-features.html" target="_blank">Chargebee RevRec</a>.</li>
        </ul></div><h4>Prerequisites</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The subscription should not be part of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource that is within an account hierarchy <a href="/docs/api/v2/pcv-1/customers/customer-object#relationship">relationship</a>.</li>
        <li class="text-base leading-relaxed">There must be no invoices with the <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">statuses</a> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">posted</code> associated with the subscription.</li>
        <li class="text-base leading-relaxed">The site must have <a href="https://www.chargebee.com/docs/1.0/consolidated-invoicing.html" target="_blank">consolidated invoicing</a> disabled.</li>
        <li class="text-base leading-relaxed">There should be no consolidated invoices linked to the subscription.</li>
        <li class="text-base leading-relaxed">No <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code> resources with the <a href="/docs/api/v2/pcv-1/credit_notes/credit_note-object#status">statuses</a> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">adjusted</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund_due</code> should be associated with the subscription.</li>
        </ul><h4>Asynchronous operation</h4><p class="mb-2">If the above prerequisites are met, the API call returns a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">200 OK</code> response containing the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription</code> resource as is. However, the actual move operation can take up to <strong class="font-semibold">five</strong> minutes to complete.</p><p class="mb-2">To know whether the operation was successful, we recommend that you watch for the <code><a href="/docs/api/v2/pcv-1/events">subscription_changed</a></code> event and see if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.customer_id</code> has changed.</p><h4>Limitations</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Subscriptions cannot be moved on the same calendar day as their renewal. For instance, if a renewal is scheduled for 2 PM on April 10, 2024, the endpoint is restricted from 12 AM on April 10, 2024, until the renewal is completed.</li>
        <li class="text-base leading-relaxed">After moving a subscription, the change does not reflect in Chargebee Billing&#x27;s <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html" target="_blank">accounting integrations</a> or in <a href="https://www.chargebee.com/docs/revrec/chargebee-billing-features.html" target="_blank">Chargebee RevRec</a>.</li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:
        Resources linked to the original customer such as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unbilled_charge</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
        , and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction</code>
        but <strong class="font-semibold">not</strong>
        linked to the subscription being moved, are <strong class="font-semibold">not</strong>
        moved to the destination customer by this operation.</p></div></div>
      operationId: move_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                to_customer_id:
                  type: string
                  deprecated: false
                  description: <p class="mb-2">Specifies the unique ID of the <code
                    class="bg-gray-100 text-gray-800 font-medium border border-gray-300
                    rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code>
                    resource to which the subscription will be moved.</p>
                  maxLength: 50
                  example: null
                copy_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>:</strong>
                    If the subscription has an <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#payment_source_id">associated <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code></a>:</p>
                    <ol class="list-decimal list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">A new duplicate copy of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code> resource is created.</li>
                    <li class="text-base leading-relaxed">This new copy of the payment source is linked to the subscription and the destination customer.</li>
                    </ol>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:
                    Deleting any copy of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code>
                    also deletes the other copies and the details stored at the payment gateway.</p></div>
                    <p class="mb-2"><strong class="font-semibold">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>:</strong>
                    No new payment source is created for the subscription. Moreover, if a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code> is already <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#payment_source_id">linked</a> to the subscription, it gets removed, meaning the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.payment_source_id</code> is cleared.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Warning</strong>:
                    When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">copy_payment_source</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    and if <code><a href="/docs/api/subscriptions/create-subscription-for-items">subscription.auto_collection</a></code>
                    is enabled, auto-collection will fail, in turn preventing subscription renewal. To prevent auto-collection failure, <a href="/docs/api/v2/pcv-1/subscriptions/override-billing-profile">link a payment source</a>
                    to the subscription after this operation.</p></div>
                  example: null
              required:
              - to_customer_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                required:
                - subscription
                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: []
  /customers/{customer-id}/import_subscription:
    post:
      summary: Import subscription for customer
      description: |
        Import the subscription details of a customer.
      operationId: import_subscription_for_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                  maxLength: 50
                  example: null
                plan_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the plan for this subscription.
                  maxLength: 100
                  example: null
                plan_quantity:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Plan quantity for this subscription.
                  minimum: 1
                  example: null
                plan_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                plan_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                plan_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    When [price overriding](http://chargebee.com/docs/price-override.html )
                    is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                    is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                setup_fee:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                    is passed, the subscription will be activated immediately.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                  enum:
                  - "on"
                  - "off"
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase order number for this subscription.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](/docs/api/coupon_codes)
                    .
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Id of the payment source to be attached to this subscription.
                  maxLength: 40
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Current state of the subscription.
                    \* future -

                    The subscription is scheduled to start at a future date.
                    \* active -

                    The subscription is active and will be charged for automatically based on the items in it.
                    \* cancelled -

                    The subscription has been canceled and is no longer in service.
                    \* transferred -

                    The subscription has been transferred to another business entity within the organization.
                    \* in_trial -

                    The subscription is in trial.
                    \* non_renewing -

                    The subscription will be canceled at the end of the current term.
                    \* paused -

                    The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).
                    The subscription will not renew while in this state.
                  enum:
                  - future
                  - in_trial
                  - active
                  - non_renewing
                  - paused
                  - cancelled
                  - transferred
                  example: null
                current_term_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For subscription status: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> is required.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                current_term_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Start of the current billing period of the subscription. This is required when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>.
                    When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                    , it defaults to the current time.</p>
                  example: null
                trial_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscription, it implies that the subscription goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                    when it starts.</p>
                  example: null
                cancelled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Time at which subscription was cancelled or is set to be cancelled.
                  example: null
                started_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Time at which the subscription was started. Is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                    for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscriptions as it is yet to be started.</p>
                  example: null
                activated_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The time at which the subscription was activated. A subscription is &quot;activated&quot; when its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> changes from any other, to either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    <p class="mb-2">The following conditions must be satisfied when passing this parameter:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must be on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">started_at</code>. Additionally, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must be on or before <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</li>
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must precede <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_start</code></li>
                    </ul>
                    <h4>Note:</h4>
                    <p class="mb-2">This parameter should not be provided when passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.</p>
                  example: null
                pause_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>
                    state, it is the date/time when the subscription was paused.</p>
                  example: null
                resume_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                create_current_term_invoice:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    if you want an invoice to be created for the subscription.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">The invoice will be created for the subscription only if it has an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code> status.</li>
                    <li class="text-base leading-relaxed">The period of the invoice is from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>.</li>
                    <li class="text-base leading-relaxed">The invoice will not be generated if the subscription amount is zero dollars (for that period) and &#x27;Hide Zero Value Line Items&#x27; option is enabled in site settings.</li>
                    </ul>
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Id that uniquely identifies the contract term in the site.
                      maxLength: 50
                      example: null
                    created_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date when the contract term was created.
                      example: null
                    contract_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The start date of the contract term
                      example: null
                    billing_cycle:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of billing cycles of the subscription that the contract term is for.
                      minimum: 0
                      example: null
                    total_amount_raised:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription. This amount
                        is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value</a></code></p>
                      minimum: 0
                      example: null
                    total_amount_raised_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription excluding
                        tax. This amount is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value_before_tax</a></code></p>
                      minimum: 0
                      example: null
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The payment transaction amount. This parameter should be passed only if the invoice is created for current term.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction. This parameter should be passed only if the invoice is created for current term.</p>
                        * cash - <p class="mb-2">Cash</p>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * custom - <p class="mb-2">Custom</p>
                        * upi - <p class="mb-2">upi</p>
                        * trustly - <p class="mb-2">Trustly</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reference number for this transaction. For example, check number in case of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method</code>.
                        This parameter should be passed only if the invoice is created for current term.</p>
                      maxLength: 100
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charged_event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charged_event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Addon id.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    last_charged_at:
                      type: array
                      description: |
                        Timestamp indicating when this add-on was last charged for this subscription.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              required:
              - plan_id
              - status
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              charged_event_based_addons:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - customer
                - subscription
                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: []
  /customers/{customer-id}/subscriptions:
    post:
      summary: Create subscription for customer
      description: "**Note:**\nThis operation optionally supports 3DS verification\
        \ flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\n\
        and pass it as input parameter to this API.\n\nCreates a new subscription\
        \ for an existing customer. You can attach a plan, plan quantity, one or more\
        \ addons and coupon while creating this subscription.\n\nIf the plan does\
        \ not have a trial period and if any of the recurring-item has charges, then\
        \ the customer is charged immediately if auto_collection is turned 'on'. In\
        \ that case, subscription is created only if the customer has a payment method\
        \ on file and attempted payment is successful.  \nIf an invoice gets generated\
        \ during this operation, available Credits and Excess Payments will be automatically\
        \ applied.\n"
      operationId: create_subscription_for_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                  maxLength: 50
                  example: null
                plan_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the plan for this subscription.
                  maxLength: 100
                  example: null
                plan_quantity:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Plan quantity for this subscription.
                  minimum: 1
                  example: null
                plan_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                plan_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                plan_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    When [price overriding](http://chargebee.com/docs/price-override.html )
                    is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                    is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                setup_fee:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                    is passed, the subscription will be activated immediately.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a <a href="/docs/api/v2/pcv-1/contract_terms">contract term</a> or not.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When the subscription is not on a contract term: if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> is not provided, then the billing cycles <a href="/docs/api/v2/pcv-1/plans/plan-object#billing_cycles">set for the plan</a> is used. Moreover, once the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> have completed, the subscription cancels.</li>
                    <li class="text-base leading-relaxed">When the subscription is on a contract term: Providing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> is mandatory. Moreover, once the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code> have completed, the behavior of the subscription is determined by the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term[action_at_term_end]</code> parameter.</li>
                    </ul>
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                  enum:
                  - "on"
                  - "off"
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                offline_payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The preferred offline payment method for the subscription.
                    \* jp_automated_bank_transfer -

                    JP Automated Bank Transfer
                    \* sepa_credit -

                    SEPA Credit
                    \* cash -

                    Cash
                    \* no_preference -

                    No Preference
                    \* uk_automated_bank_transfer -

                    UK Automated Bank Transfer
                    \* custom -

                    Custom
                    \* bank_transfer -

                    Bank Transfer
                    \* boleto -

                    Boleto
                    \* check -

                    Check
                    \* mx_automated_bank_transfer -

                    MX Automated Bank Transfer
                    \* us_automated_bank_transfer -

                    US Automated Bank Transfer
                    \* eu_automated_bank_transfer -

                    EU Automated Bank Transfer
                    \* ach_credit -

                    ACH Credit
                  enum:
                  - no_preference
                  - cash
                  - check
                  - bank_transfer
                  - ach_credit
                  - sepa_credit
                  - boleto
                  - us_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - uk_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  - custom
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase order number for this subscription.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Id of the payment source to be attached to this subscription.
                  maxLength: 40
                  example: null
                override_relationship:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , ignores the <a href="/docs/api/customers/customer-object#relationship">hierarchy relationship</a>
                    and uses customer as payment and invoice owner.</p>
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.</li>
                    <li class="text-base leading-relaxed">It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is true.
                    .</li>
                    </ul>
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                free_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
                  minimum: 1
                  example: null
                free_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                    attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                    chosen.
                    \* week -

                    Charge based on week(s)
                    \* month -

                    Charge based on month(s)
                    \* day -

                    Charge based on day(s)
                    \* year -

                    Charge based on year(s)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
                    \* cancel_subscription -

                    The subscription cancels.
                    \* activate_subscription -

                    The subscription activates and charges are raised for non-metered items.
                    \* plan_default -

                    The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                    \* site_default -

                    This is the default value. This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                  enum:
                  - site_default
                  - plan_default
                  - activate_subscription
                  - cancel_subscription
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for statement_descriptor
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)
                        text configured in the Chargebee site for all the subscription renewal transactions.
                      maxLength: 65000
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* go_pay -

                        Payments made via GoPay
                        \* google_pay -

                        google_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* ideal -

                        ideal
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* online_banking_poland -

                        Online Banking Poland
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Sub Item Plan Unit Amount for create subscription
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        Sub Item Plan Unit Amount in Decimal for create subscription
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                        status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        )</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
              required:
              - plan_id
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/retrieve_advance_invoice_schedule:
    get:
      summary: Retrieve advance invoice
      description: |
        Retrieves the *advance_invoice_schedule* for a subscription. Note that this endpoint is only applicable for *schedule_type = specific_dates* or fixed_intervals.
      operationId: retrieve_advance_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  advance_invoice_schedules:
                    type: array
                    description: <p class="mb-2">Resource object representing advance_invoice_schedule</p>
                    items:
                      $ref: "#/components/schemas/AdvanceInvoiceSchedule"
                      description: Resource object representing advance_invoice_schedule
                    example: null
                required:
                - advance_invoice_schedules
                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: []
  /subscriptions/{subscription-id}/remove_scheduled_cancellation:
    post:
      summary: Remove scheduled cancellation
      description: "<div class=\"api-description\"><div class=\"alert alert-info\"\
        ><p class=\"mb-2\"><strong class=\"font-semibold\">Note:</strong> Cannot be\
        \ called when the subscription is on a <a href=\"/docs/api/contract_terms\"\
        >contract term</a>. (That is, when the <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">contract_term.status attribute</code> is <code class=\"\
        bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5\
        \ py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code>.)</p></div><p\
        \ class=\"mb-2\">If the subscription is in <strong class=\"font-semibold\"\
        >Non Renewing</strong> or <strong class=\"font-semibold\">In Trial</strong>\
        \ state and is also scheduled to cancel at the end of current term, then this\
        \ API can be used to remove the scheduled cancellation. When a scheduled cancellation\
        \ is removed, the subscription will revert to <strong class=\"font-semibold\"\
        >Active</strong> or <strong class=\"font-semibold\">In Trial</strong> state,\
        \ whichever is the state before cancellation was scheduled.</p><p class=\"\
        mb-2\">While removing the scheduled cancellation, you may specify the number\
        \ of billing cycles. If the billing cycle is not specified, the default billing\
        \ cycle from the plan will be applied on the subscription.</p></div>"
      operationId: remove_scheduled_cancellation
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
              example: null
            encoding:
              contract_term:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/retrieve_with_scheduled_changes:
    get:
      summary: Retrieve with scheduled changes
      description: |-
        <div class="api-description"><p class="mb-2">Retrieves a subscription with the scheduled changes applied. If the subscription has one or more <a href="ramps" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ramp</code></a>s, this API returns the subscription with the upcoming ramp applied.</p><p class="mb-2"><strong class="font-semibold">Note:</strong> Only the following attributes are changed</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">plan_id</li>
        <li class="text-base leading-relaxed">plan_quantity</li>
        <li class="text-base leading-relaxed">plan_unit_price</li>
        <li class="text-base leading-relaxed">setup_fee</li>
        <li class="text-base leading-relaxed">billing_period</li>
        <li class="text-base leading-relaxed">billing_period_unit</li>
        <li class="text-base leading-relaxed">plan_free_quantity</li>
        <li class="text-base leading-relaxed">remaining_billing_cycles</li>
        <li class="text-base leading-relaxed">addons</li>
        <li class="text-base leading-relaxed">coupons
        Other attributes such as <strong class="font-semibold">status</strong>
        ,<strong class="font-semibold">next_billing_at</strong>
        are not changed and will reflect the current subscription values.</li>
        </ul></div>
      operationId: retrieve_with_scheduled_changes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/reactivate:
    post:
      summary: Reactivate a subscription
      description: "**Note:**\nThis operation optionally supports 3DS verification\
        \ flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\n\
        and pass it as input parameter to this API.\n\nThis API is used to reactivate\
        \ a **cancelled** subscription. You may also optionally specify a trial end\
        \ date, to move the subscription to **In Trial** state. If trial end is not\
        \ specified, the subscription will be activated and any applicable charges\
        \ will be initiated.\n\nUnless the billing cycle is specified, it will be\
        \ set to plan's default billing cycle.\n\nDuring an in-term reactivation++,\
        \ unless the billing cycle is specified, the subscription's remaining billing\
        \ cycles will be restored. If a trial end date is specified, then the plan's\
        \ default billing cycle is used.\n\n**What is an \"in-term reactivation\"\
        ?**\nAn \"in-term reactivation\" happens when the billing term of the subscription\
        \ is retained upon cancellation and reactivation is initiated within that\
        \ term.\n\n**When is the 'billing term' retained for a cancelled subscription?**\n\
        When dunning (payment failure retry settings) is configured with the last\
        \ retry configured as\n\n* cancel subscription and mark invoice as 'Not Paid',\
        \ or\n* cancel subscription and mark the invoice as 'Voided' and the case\
        \ if any of the current term invoices is partially or fully paid, the invoice\
        \ is not voided but instead Chargebee marks the invoices as 'Not Paid'.\n\n\
        **Note :** In both cases, the billing term is retained and upon reactivation\
        \ the subscription will be moved to active state (if the plan does not have\
        \ a trial period) and no invoice will be generated. Ensure that you collect\
        \ any unpaid invoices.\n\n**Example :** A Subscription was billed from 1st\
        \ to 31st of a month and it was cancelled on the 20th due to one of the above\
        \ cases (billing term is not reset). If the reactivation happens on 25th then\
        \ it is considered an in-term reactivation.  \nReactivation of a subscription\
        \ in **non_renewing** state has been deprecated. To remove a scheduled cancellation\
        \ of a **non_renewing** Subscription, use [Remove Scheduled Cancellation](/docs/api/subscriptions/remove-scheduled-cancellation)\
        \ API.\nHowever, if you use reactivate API to remove scheduled cancellation\
        \ for a **non_renewing** Subscription, then the status will be set to **active**\
        \ and the billing cycle will be set to forever. If any value is passed for\
        \ trial_end or billing cycle, an error will be thrown.\nIf an invoice gets\
        \ generated during this operation, available Credits and Excess Payments will\
        \ be automatically applied.\n**Additional Error Scenarios:** If there is a\
        \ need to create an immediate charge and the collection fails, an error will\
        \ be thrown.\n"
      operationId: reactivate_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Providing this parameter indicates that the subscription reactivates with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    and the trial period ends at the date provided. The value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>.
                    Note: This parameter can be backdated (set to a value in the past) only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    has been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>
                    is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                    status.</p>
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The date/time at which the subscription was reactivated.  When not provided, the subscription is reactivated immediately on calling this API. The value of this parameter must always be in the past (backdating). Do this when the subscription has already been reactivated and the billing has been delayed. The following prerequisites must be met for this parameter to be passed:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">The backdating feature has been enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when calendar billing is enabled and a new *active*
                    term gets started during this operation. Unless specified the configured *default*
                    value will be used.
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                  enum:
                  - immediate
                  - delayed
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    .</li>
                    </ul>
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for statement_descriptor
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)
                        text configured in the Chargebee site for all the subscription renewal transactions.
                      maxLength: 65000
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* payme -

                        Payments made via PayMe
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* go_pay -

                        Payments made via GoPay
                        \* pay_by_bank -

                        Pay By Bank
                        \* google_pay -

                        google_pay
                        \* apple_pay -

                        apple_pay
                        \* online_banking_poland -

                        Online Banking Poland
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* giropay -

                        giropay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* ideal -

                        ideal
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
              example: null
            encoding:
              contract_term:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/charge_future_renewals:
    post:
      summary: Charge Future Renewals
      description: |-
        <div class="api-description"><p class="mb-2">Creates an advance invoice or an <a href="/docs/api/advance_invoice_schedules">advance invoicing schedule</a>. When an advance invoice is generated, and <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#auto_collection"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code></a> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code> for the subscription, the <a href="/docs/api/subscriptions/subscription-object#payment_source_id"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code></a> associated with the subscription is charged. Any changes scheduled for the subscription are taken into account automatically while generating an advance invoice. Advance invoices are not generated for a subscription when it is in the <a href="/docs/api/subscriptions/subscription-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code></a> status.</p><div class="alert alert-info"><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">This operation is supported only on select plans. To know more, take a look at our <a href="https://www.chargebee.com/pricing/" target="_blank">plans and pricing page</a>.</li>
        <li class="text-base leading-relaxed">This operation is not supported for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code> subscriptions.</li>
        <li class="text-base leading-relaxed">This operation is not supported if an advance invoice is already present. You could void/delete that invoice and try creating another advance invoice.</li>
        </ul></div></div>
      operationId: charge_future_renewals
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                terms_to_charge:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type = immediate</code>: the number of future billing cycles to be invoiced in advance. The invoicing is done for the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a> of the subscription if that is less than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>.</li>
                    <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type = fixed_intervals</code>: The number of future billing cycles in one <a href="/docs/api/advance_invoice_schedules">interval</a>. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles">remaining_billing_cycles</a> of the subscription.
                    .</li>
                    </ul>
                  minimum: 1
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the charge should be invoiced immediately or added to <a href="/docs/api/unbilled_charges"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unbilled_charges</code></a>.
                    Applicable only when <a href="/docs/api/subscriptions/charge-future-renewals#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediate</code>
                    .</p>
                  example: null
                schedule_type:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The type of advance invoice or advance invoicing schedule.</p>
                    * immediate - <p class="mb-2">Charge immediately for the number of billing cycles specified by <a href="/docs/api/subscriptions/charge-future-renewals#terms_to_charge"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code></a>
                    .</p>
                    * specific_dates - <p class="mb-2">Charge on <a href="/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date">specific dates</a>.
                    For each date, specify the <a href="/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge">number of billing cycles</a>
                    to charge for. Up to 5 dates can be configured.</p>
                    * fixed_intervals - <p class="mb-2">Charge at fixed intervals of time. Specify the <a href="/docs/api/subscriptions/charge-future-renewals#terms_to_charge">number of billing cycles</a>
                    that constitute an interval and the number of <a href="/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal">days before each interval</a>
                    that the invoice should be generated. Also specify <a href="/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_end_schedule_on">when the schedule should end</a>
                    .</p>
                  enum:
                  - immediate
                  - specific_dates
                  - fixed_intervals
                  example: null
                fixed_interval_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for fixed_interval_schedule
                  properties:
                    number_of_occurrences:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a>
                        of the subscription.  This parameter is applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">after_number_of_intervals</code></p>
                      minimum: 1
                      example: null
                    days_before_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before each interval that advance invoices are generated.
                      minimum: 1
                      example: null
                    end_schedule_on:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies when the schedule should end.</p>
                        * after_number_of_intervals - <p class="mb-2">Advance invoices are generated a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specified number of times</code></p>
                        * subscription_end - <p class="mb-2">Advance invoices are generated for as long as the subscription is active.</p>
                        * specific_date - <p class="mb-2">End the advance invoicing schedule on a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific date</code>
                        .</p>
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                        .</p>
                      example: null
                  example: null
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for specific_dates_schedule
                  properties:
                    terms_to_charge:
                      type: array
                      description: |-
                        <p class="mb-2">The number of billing cycles to charge for, on the date specified. Applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is specific_dates.</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_dates</code>
                        .</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              fixed_interval_schedule:
                style: deepObject
                explode: true
              specific_dates_schedule:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  advance_invoice_schedules:
                    type: array
                    description: <p class="mb-2">Resource object representing advance_invoice_schedule</p>
                    items:
                      $ref: "#/components/schemas/AdvanceInvoiceSchedule"
                      description: Resource object representing advance_invoice_schedule
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/add_charge_at_term_end:
    post:
      summary: Add charge at term end
      description: "Adds a one time charge to the subscription which will be added\
        \ to the invoice generated at the end of the current term. If there are any\
        \ applicable coupons in the subscription, an appropriate discount will be\
        \ applied.\n\nTo collect a charge immediately, [use this API](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge).\
        \  \nIf any subscription changes happen before the end of the current term,\
        \ these charges will be collected along with it.\n"
      operationId: add_charge_at_term_end
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 1
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description for this charge.
                  maxLength: 250
                  example: null
                amount_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                    Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* consumed -

                    Transaction is for an item that is consumed directly
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the charge starts.
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the charge ends.
                  example: null
              required:
              - description
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/remove_scheduled_changes:
    post:
      summary: Remove scheduled changes
      description: |
        Removes the subscription changes scheduled on next renewal. Advance charges, if any, will be refunded as credits and a new invoice will be generated on renewal.
      operationId: remove_scheduled_changes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  credit_notes:
                    type: array
                    description: <p class="mb-2">Resource object representing credit_note</p>
                    items:
                      $ref: "#/components/schemas/CreditNote"
                      description: Resource object representing credit_note
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/change_term_end:
    post:
      summary: Change term end
      description: "Changes the subscription's current term end date. Depending on\
        \ the \"status\" of the subscription, \"term end date\" has different effects.\n\
        \n* If the Subscription is in **trial**, it affects trial end date.\n* If\
        \ the Subscription is **active**, it affects the next billing date.\n* If\
        \ the Subscription's status is **non_renewing**, this affects the upcoming\
        \ cancellation date.\n\n**Tip**: To cycle through a couple of billing cycles\
        \ and test webhooks, you may use this API.  \n* When changing the *term_end*\
        \ for *active* / *non_renewing* subscriptions, by default no additional charges\
        \ (when term gets extended) will be added or credits (when term gets reduced)\
        \ will be issued. However you can specify *prorate* param as *true* for adding\
        \ prorated charges / issuing prorated credits. Further for the charges that\
        \ got added, you can specify *invoice_immediately* as *false* to add them\
        \ to *unbilled charges* and invoice them later.\n* Advance charges, if any\
        \ will be credited back during this operation.\n* Confirm the UTC (Coordinated\
        \ Universal Time) time zone selected in your Chargebee site matches with your\
        \ country region.\n"
      operationId: change_term_end
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                term_ends_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the current term should end for this subscription.
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable for *active*
                    / *non_renewing*
                    subscriptions. If specified as *true*
                    prorated charges / credits will be added during this operation.
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
              required:
              - term_ends_at
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: <p class="mb-2">Resource object representing credit_note</p>
                    items:
                      $ref: "#/components/schemas/CreditNote"
                      description: Resource object representing credit_note
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/delete:
    post:
      summary: Delete a subscription
      description: "Deletes the subscription resource.  \nThis operation is irreversible\
        \ - all data related to the subscription, such as invoices, transactions,\
        \ and reports, will be deleted.\n**Note:** This operation schedules the subscription\
        \ resource for deletion. It will be deleted in a few minutes.\n"
      operationId: delete_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/import_subscription:
    post:
      summary: Import a subscription
      description: |
        Imports a subscription into Chargebee.
      operationId: import_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id for the new subscription. If not given, this will be auto-generated.
                  maxLength: 50
                  example: null
                client_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  maxLength: 50
                  example: null
                plan_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the plan for this subscription.
                  maxLength: 100
                  example: null
                plan_quantity:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Plan quantity for this subscription.
                  minimum: 1
                  example: null
                plan_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                plan_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                plan_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    When [price overriding](http://chargebee.com/docs/price-override.html )
                    is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                    is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                setup_fee:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                    is passed, the subscription will be activated immediately.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                  enum:
                  - "on"
                  - "off"
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase order number for this subscription.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Current state of the subscription.
                    \* future -

                    The subscription is scheduled to start at a future date.
                    \* non_renewing -

                    The subscription will be canceled at the end of the current term.
                    \* active -

                    The subscription is active and will be charged for automatically based on the items in it.
                    \* cancelled -

                    The subscription has been canceled and is no longer in service.
                    \* transferred -

                    The subscription has been transferred to another business entity within the organization.
                    \* in_trial -

                    The subscription is in trial.
                    \* paused -

                    The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).
                    The subscription will not renew while in this state.
                  enum:
                  - future
                  - in_trial
                  - active
                  - non_renewing
                  - paused
                  - cancelled
                  - transferred
                  example: null
                current_term_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For subscription status: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> is required.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                current_term_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Start of the current billing period of the subscription. This is required when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>.
                    When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                    , it defaults to the current time.</p>
                  example: null
                trial_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscription, it implies that the subscription goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                    when it starts.</p>
                  example: null
                cancelled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Time at which subscription was cancelled or is set to be cancelled.
                  example: null
                started_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Time at which the subscription was started. Is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                    for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscriptions as it is yet to be started.</p>
                  example: null
                activated_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The time at which the subscription was activated. A subscription is &quot;activated&quot; when its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> changes from any other, to either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    <p class="mb-2">The following conditions must be satisfied when passing this parameter:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must be on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">started_at</code>. Additionally, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must be on or before <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</li>
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">activated_at</code> must precede <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_start</code></li>
                    </ul>
                    <h4>Note:</h4>
                    <p class="mb-2">This parameter should not be provided when passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.</p>
                  example: null
                pause_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>
                    state, it is the date/time when the subscription was paused.</p>
                  example: null
                resume_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
                  example: null
                create_current_term_invoice:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    if you want an invoice to be created for the subscription.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">The invoice will be created for the subscription only if it has an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code> status.</li>
                    <li class="text-base leading-relaxed">The period of the invoice is from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>.</li>
                    <li class="text-base leading-relaxed">The invoice will not be generated if the subscription amount is zero dollars (for that period) and &#x27;Hide Zero Value Line Items&#x27; option is enabled in site settings.</li>
                    </ul>
                  example: null
                affiliate_token:
                  type: string
                  deprecated: false
                  description: |
                    A unique tracking token.
                  maxLength: 250
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique ID of the customer for which this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>
                        should be created. When not provided, a new customer is created with the ID set to the value provided for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>.
                        If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>
                        is unavailable, then the customer ID is autogenerated.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Company name of the customer.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the customer
                      maxLength: 50
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies if the customer is liable for tax</p>
                        * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                        <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                        </ul>
                        * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                        In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                      enum:
                      - taxable
                      - exempt
                      example: null
                    entity_code:
                      type: string
                      deprecated: false
                      description: |
                        The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                        \* med2 -

                        US Medical Device Excise Tax with taxable sales tax
                        \* med1 -

                        US Medical Device Excise Tax with exempt sales tax
                        \* b -

                        State government
                        \* c -

                        Tribe/Status Indian/Indian Band
                        \* a -

                        Federal government
                        \* f -

                        Religious organization
                        \* g -

                        Resale
                        \* d -

                        Foreign diplomat
                        \* e -

                        Charitable or benevolent organization
                        \* j -

                        Direct pay permit
                        \* k -

                        Direct mail
                        \* h -

                        Commercial agricultural production
                        \* i -

                        Industrial production/manufacturer
                        \* n -

                        Local government
                        \* l -

                        Other or custom
                        \* m -

                        Educational organization
                        \* r -

                        Non-resident
                        \* p -

                        Commercial aquaculture
                        \* q -

                        Commercial Fishery
                      enum:
                      - a
                      - b
                      - c
                      - d
                      - e
                      - f
                      - g
                      - h
                      - i
                      - j
                      - k
                      - l
                      - m
                      - "n"
                      - p
                      - q
                      - r
                      - med1
                      - med2
                      example: null
                    exempt_number:
                      type: string
                      deprecated: false
                      description: |
                        Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                      maxLength: 100
                      example: null
                    net_term_days:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days within which the customer has to make payment for the invoice.
                      example: null
                    taxjar_exemption_category:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration.
                        \* wholesale -

                        Whole-sale
                        \* other -

                        Other
                        \* government -

                        Government
                      enum:
                      - wholesale
                      - government
                      - other
                      example: null
                    customer_type:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                        \* senior_citizen -

                        When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
                        \* business -

                        When the purchase is made at a place of business
                        \* residential -

                        When the purchase is made by a customer for home use
                        \* industrial -

                        When the purchase is made by an industrial business
                      enum:
                      - residential
                      - business
                      - senior_citizen
                      - industrial
                      example: null
                    auto_collection:
                      type: string
                      default: "on"
                      deprecated: false
                      description: |
                        Whether payments needs to be collected automatically for this customer
                        \* on -

                        Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
                        \* off -

                        Automatic collection of charges will not be made. All payments must be recorded offline.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    allow_direct_debit:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether the customer can pay via Direct Debit
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Id that uniquely identifies the contract term in the site.
                      maxLength: 50
                      example: null
                    created_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date when the contract term was created.
                      example: null
                    contract_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The start date of the contract term
                      example: null
                    billing_cycle:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of billing cycles of the subscription that the contract term is for.
                      minimum: 0
                      example: null
                    total_amount_raised:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription. This amount
                        is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value</a></code></p>
                      minimum: 0
                      example: null
                    total_amount_raised_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription excluding
                        tax. This amount is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value_before_tax</a></code></p>
                      minimum: 0
                      example: null
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* visa -\n\nA Visa card scheme.\n\\* mada -\n\nA Mada card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made\
                        \ via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\
                        \nPayments made via Sofort.\n\\* twint -\n\nPayments made\
                        \ via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                        \ Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay\
                        \ -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* upi -\n\nUPI Payments.\n\\\
                        * revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments\
                        \ made via Alipay.  \nThis payment source is deprecated.\n\
                        \\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments\
                        \ made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\
                        \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                        \ -\n\nPayments made via WeChat Pay.  \nThis payment source\
                        \ is deprecated.\n\\* sepa_instant_transfer -\n\nPayments\
                        \ made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
                        \ made via Dotpay.\n\\* paypal_express_checkout -\n\nPayments\
                        \ made via PayPal Express Checkout.\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* faster_payments -\n\nPayments made via\
                        \ Faster Payments\n\\* swish -\n\nPayments made via Swish\n\
                        \\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* amazon_payments -\n\nPayments made via\
                        \ Amazon Payments.\n\\* card -\n\nCard based payment including\
                        \ credit cards and debit cards. Details about the card can\
                        \ be obtained from the card resource.\n\\* trustly -\n\nTrustly\n\
                        \\* kbc_payment_button -\n\nKBC Payment Button\n\\* cash_app_pay\
                        \ -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The payment transaction amount. This parameter should be passed only if the invoice is created for current term.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction. This parameter should be passed only if the invoice is created for current term.</p>
                        * cash - <p class="mb-2">Cash</p>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * custom - <p class="mb-2">Custom</p>
                        * upi - <p class="mb-2">upi</p>
                        * trustly - <p class="mb-2">Trustly</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reference number for this transaction. For example, check number in case of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method</code>.
                        This parameter should be passed only if the invoice is created for current term.</p>
                      maxLength: 100
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charged_event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charged_event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Addon id.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    last_charged_at:
                      type: array
                      description: |
                        Timestamp indicating when this add-on was last charged for this subscription.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              required:
              - plan_id
              - status
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              charged_event_based_addons:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/import_unbilled_charges:
    post:
      description: |
        Imports unbilled charges into Chargebee.
      operationId: import_unbilled_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                unbilled_charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for unbilled_charges
                  properties:
                    id:
                      type: array
                      description: |
                        Uniquely identifies an unbilled charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        Start date of this charge.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        End date of this charge.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies the modelled entity this line item is based on.
                          \* plan -

                          Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                          \* charge_item_price -

                          Indicates that this line item is based on charge Item Price
                          \* addon_item_price -

                          Indicates that this line item is based on addon Item Price
                          \* plan_setup -

                          Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                          \* adhoc -

                          Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                          \* addon -

                          Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                          id
                          \* plan_item_price -

                          Indicates that this line item is based on plan Item Price
                        enum:
                        - plan_setup
                        - plan
                        - addon
                        - adhoc
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Detailed description about this charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        Unit amount of the charge item.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Quantity of the item which is represented by this charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Total amount of this charge. Typically equals to unit amount x quantity.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the amount for the charge, in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                        x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                        Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    discount_amount:
                      type: array
                      description: |
                        Total discounts for this charge.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    use_for_proration:
                      type: array
                      description: |
                        If the unbilled charge falls within the subscription's current term it will be used for proration.
                      items:
                        type: boolean
                        default: false
                        deprecated: false
                        example: null
                      example: null
                    is_advance_charge:
                      type: array
                      description: |
                        The value of this parameter will be true if it is a recurring unbilled charge for a future term.
                      items:
                        type: boolean
                        default: false
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - date_from
                  - date_to
                  - entity_type
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    unbilled_charge_id:
                      type: array
                      description: |
                        Uniquely identifies an unbilled charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                          * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                          in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                          .</p>
                          * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                          * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                          * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                          applied to the invoice.</p>
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |-
                        <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                        , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the coupon. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this deduction.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  required:
                  - amount
                  example: null
                tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tiers
                  properties:
                    unbilled_charge_id:
                      type: array
                      description: |
                        Uniquely identifies an unbilled charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    quantity_used:
                      type: array
                      description: |
                        The number of units purchased in a range.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                  required:
                  - unbilled_charge_id
                  example: null
              example: null
            encoding:
              discounts:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
              unbilled_charges:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - unbilled_charges
                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: []
  /subscriptions/{subscription-id}/remove_scheduled_resumption:
    post:
      summary: Remove scheduled resumption
      description: |
        If the subscription is in **Paused** state and is scheduled to resume on a specific_date, this API can be used to remove the scheduled resumption. When the scheduled resumption is removed, the subscription will remain **Paused**.
      operationId: remove_scheduled_resumption
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}:
    get:
      summary: Retrieve a subscription
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Retrieves details of a subscription.</p></div>
      operationId: retrieve_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
    post:
      summary: Update a subscription
      description: "**Note:**\n\n* This operation optionally supports 3DS verification\
        \ flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\
        \ and pass it as input parameter to this API.\n* When the **Remove mandatory\
        \ add-ons from old plan during subscription plan update** setting is [enabled](https://www.chargebee.com/docs/1.0/subscriptions.html#editing-a-subscription_remove-mandatory-addons)\
        \ on your Chargebee site, all [mandatory addons](/docs/api/attached_items)\
        \ with the old plan will be automatically removed during the subscription\
        \ update to a new plan.\n\nYou can modify the plan, plan quantity and add\
        \ or remove addons for the subscription. By default the changes are applied\
        \ immediately and the charges (/credits) are prorated and adjusted with the\
        \ next billing term. You may also choose to effect the changes at the end\
        \ of the current term by passing **end_of_term** as \"true\". In this case\
        \ proration will not be done.\n\nOnly the parameters that are passed are modified\
        \ for the subscription. Rest will reflect the existing values.\n\nBy default,\
        \ the addons passed are appended to the existing list of addons for this subscription.\
        \ In case a passed addon already exists for this subscription, quantity value\
        \ is replaced. If you want to completely replace the addons for this subscription,\
        \ pass **replace_addon_list** as \"true\".\n\n[Card](/docs/api/cards/card-object)\
        \ and 'vat_number' attributes can also be passed during subscription update.\
        \ If they are passed, corresponding Billing Info attributes - the [Billing\
        \ Address](/docs/api/customers/customer-object) and 'vat_number' - will be\
        \ replaced automatically.\n\nPassing credit card details to this API involves\
        \ PCI liability at your end as sensitive card info passes through your servers.\
        \ If you wish to avoid that, you can use one of the following integration\
        \ methodologies if applicable\n\n* If you are using Stripe gateway, you can\
        \ use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form.\
        \ Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges)\
        \ for more details.\n* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript)\
        \ with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html)\
        \ for more details.\n* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html)\
        \ with your checkout form.\n* If you are using the Adyen gateway, you will\
        \ have to use the Adyen's [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce)\
        \ to encrypt sensitive cardholder data. Once the cardholder data is encrypted,\
        \ pass the value in adyen.encrypted.data as temp token in this API.\n* You\
        \ can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html)\
        \ based integration.\n\n**Proration Scenario:** A customer changes from a\
        \ $15 plan to $30 plan after 15 days of a monthly term. He will be charged\
        \ for $7.50 immediately. The following Credit Note and Invoice will be generated\
        \  \n\n|-------------------------------|-------|\n| **Credit Note**      \
        \         |\n| Prorated credits for Old Plan | $7.50 |\n\n|-------------------------------|---------|\n\
        | **Invoice**                   |\n| Prorated charges for New Plan | $15.00\
        \  |\n| Total                         | $15.00  |\n| Credits             \
        \          | ($7.50) |\n| **Amount Due**                | $7.50   |\n\nMeanwhile\
        \ downgrading will result in net credits being created which will be applied\
        \ when the subscription is charged on start of the next term. Learn more about\
        \ our proration scenarios [here](https://www.chargebee.com/docs/proration.html).\n\
        \n**Billing Cycle:** The billing period for a subscription does not change\
        \ if the plans intervals of both old and new are same. However, if a customer\
        \ changes to a plan that has different billing interval(say monthly to yearly),\
        \ the billing period is reset. Customer is charged immediately for the modified\
        \ subscription after applying credit for the unused period for the old subscription.\n\
        **Card and VAT number Input:** If they are passed, corresponding [Billing\
        \ Address](/docs/api/customers/customer-object) attributes and [vat_number](/docs/api/customers/customer-object)\
        \ will be replaced. i.e existing values for Billing Address and 'vat_number'\
        \ will be cleared and the new values will be set.\nIf an invoice gets generated\
        \ during this operation, available Credits and Excess Payments will be automatically\
        \ applied.\n\n**Advance charges**, if any, will be refunded as credits and\
        \ a new invoice will be generated on renewal.\n"
      operationId: update_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                plan_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the plan for this subscription.
                  maxLength: 100
                  example: null
                plan_quantity:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Represents the plan quantity for this subscription.
                  minimum: 1
                  example: null
                plan_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">Amount that will override the plan&#x27;s default price. The unit depends on the <a href="/docs/api/getting-started">type of currency</a>.
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    is in the past and a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_unit_price</code>
                    is not passed, then the plan&#x27;s current unit price is considered even if the plan did not exist on the date as of when the change is scheduled.</p>
                  minimum: 0
                  example: null
                setup_fee:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                replace_addon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing addons should be replaced with the ones that are being passed.
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    A list of IDs representing the [mandatorily attached addons](/docs/api/attached_items)
                    associated with the plan to which the subscription is being updated. These addons will be removed from the subscription during the subscription update process.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                plan_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                plan_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <a href="https://www.chargebee.com/docs/price-override.html" target="_blank">price overriding</a>
                    is enabled for the site, the price or per-unit price of the item can be set here. The <a href="/docs/api/item_prices/item_price-object#price">value set for the item price</a>
                    is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/getting-started">multi-decimal pricing</a>
                    is enabled. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    is in the past and a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code>
                    is not passed, then the item price&#x27;s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.</p>
                  maxLength: 39
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date.  taxes and line_item_taxes are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    .</li>
                    </ul>
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The new start date of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscription. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                    subscriptions.</p>
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The time at which the trial has ended or will end for the subscription. Set it to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code> to have no trial period.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">This is only allowed when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.</li>
                    <li class="text-base leading-relaxed">The value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.</li>
                    <li class="text-base leading-relaxed">This parameter can be backdated (set to a value in the past) only when the subscription is in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>. Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code> is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code> status.</li>
                    </ul></div>
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">If the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changed_scheduled_at</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating must be enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is on or after the last date/time any of the product catalog items of the subscription were changed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    chosen for the site for calendar billing. Only applicable when using calendar billing.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                  enum:
                  - "on"
                  - "off"
                  example: null
                offline_payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The preferred offline payment method for the subscription.
                    \* sepa_credit -

                    SEPA Credit
                    \* cash -

                    Cash
                    \* no_preference -

                    No Preference
                    \* bank_transfer -

                    Bank Transfer
                    \* check -

                    Check
                    \* eu_automated_bank_transfer -

                    EU Automated Bank Transfer
                    \* jp_automated_bank_transfer -

                    JP Automated Bank Transfer
                    \* uk_automated_bank_transfer -

                    UK Automated Bank Transfer
                    \* custom -

                    Custom
                    \* boleto -

                    Boleto
                    \* mx_automated_bank_transfer -

                    MX Automated Bank Transfer
                    \* us_automated_bank_transfer -

                    US Automated Bank Transfer
                    \* ach_credit -

                    ACH Credit
                  enum:
                  - no_preference
                  - cash
                  - check
                  - bank_transfer
                  - ach_credit
                  - sepa_credit
                  - boleto
                  - us_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - uk_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  - custom
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase order number for this subscription.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |-
                    <p class="mb-2">List of coupons to be applied to this subscription. You can provide coupon ids or <a href="/docs/api/coupon_codes">coupon codes</a>.
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    is in the past, then the currently available coupons can be used even if they were not available as of the date for when the change is scheduled.</p>
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    then the existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    list for the subscription is replaced by the one provided. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    then the provided list gets added to the existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    .</p>
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism" target="_blank">Prorated credits or charges</a> are created as applicable for this change.</li>
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: The subscription is changed without creating any credits or charges.</li>
                    <li class="text-base leading-relaxed">When not provided, the value configured in the <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site settings</a> is considered.</li>
                    </ul>
                    <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Caveat</strong></p><p class="mb-2">For further changes within the same billing term, when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">prorate</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, <strong class="font-semibold">credits</strong> are <strong class="font-semibold">not created</strong> when <strong class="font-semibold">all</strong> the conditions below hold true:</p><p class="mb-2">An immediate previous change was made</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">prorate</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> and</li>
                    <li class="text-base leading-relaxed">no changes were made to the subscription&#x27;s billing term and</li>
                    <li class="text-base leading-relaxed">a change was made to either the subscription&#x27;s plan, its addons, or the prices of the plan or addons.</li>
                    </ul></div>
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    will have the subscription reset its term to the current date (provided <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_of_term</code>
                    is false).
                    <strong class="font-semibold">Note</strong>:
                    When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.</p>
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    of the subscription is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    , this parameter determines whether the subscription is reactivated upon making this API request. Unless passed explicitly as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    , this parameter is implied as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    when you provide <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_id</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addons[id]</code></p>
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The Chargebee payment token generated by <a href="https://www.chargebee.com/checkout-portal-docs/3ds-helper-overview.html#using-gateway-s-hosted-fields">Chargebee JS</a>.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:
                    The payment token created via Chargebee JS uses the gateway selected through <a href="https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing">Smart Routing</a>.
                    Explicitly passing a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway_id</code>
                    in this API call will not override the gateway associated with the token.</p></div>
                  maxLength: 40
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                override_relationship:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , ignores the <a href="/docs/api/customers/customer-object#relationship">hierarchy relationship</a>
                    and uses customer as payment and invoice owner.</p>
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                    , then set the date/time at which the subscription change is to happen or has happened. <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Backdating must be enabled for subscription change operations.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Only the following changes can be backdated:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after the last date/time any of the following changes were made:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February..</p>
                    </li>
                    </ul>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    parameter does not apply to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                    , and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">po_number</code>
                    ; these parameters take effect <strong class="font-semibold">immediately</strong>
                    when scheduling a subscription update.</p></div>
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.</p>
                    * end_of_term - <p class="mb-2">The change is carried out at the end of the current billing cycle of the subscription.</p>
                    * specific_date - <p class="mb-2">The change is carried out as of the date specified under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    .</p>
                    * immediately - <p class="mb-2">The change is carried out immediately.</p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                free_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
                  minimum: 1
                  example: null
                free_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                    attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                    chosen.
                    \* week -

                    Charge based on week(s)
                    \* month -

                    Charge based on month(s)
                    \* day -

                    Charge based on day(s)
                    \* year -

                    Charge based on year(s)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
                    \* activate_subscription -

                    The subscription activates and charges are raised for non-metered items.
                    \* cancel_subscription -

                    The subscription cancels.
                    \* plan_default -

                    The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                    \* site_default -

                    This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                  enum:
                  - site_default
                  - plan_default
                  - activate_subscription
                  - cancel_subscription
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* visa -\n\nA Visa card scheme.\n\\* mada -\n\nA Mada card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made\
                        \ via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\
                        \nPayments made via Sofort.\n\\* twint -\n\nPayments made\
                        \ via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                        \ Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay\
                        \ -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* upi -\n\nUPI Payments.\n\\\
                        * revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments\
                        \ made via Alipay.  \nThis payment source is deprecated.\n\
                        \\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments\
                        \ made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\
                        \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                        \ -\n\nPayments made via WeChat Pay.  \nThis payment source\
                        \ is deprecated.\n\\* sepa_instant_transfer -\n\nPayments\
                        \ made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
                        \ made via Dotpay.\n\\* paypal_express_checkout -\n\nPayments\
                        \ made via PayPal Express Checkout.\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* faster_payments -\n\nPayments made via\
                        \ Faster Payments\n\\* swish -\n\nPayments made via Swish\n\
                        \\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* amazon_payments -\n\nPayments made via\
                        \ Amazon Payments.\n\\* card -\n\nCard based payment including\
                        \ credit cards and debit cards. Details about the card can\
                        \ be obtained from the card resource.\n\\* online_banking_poland\
                        \ -\n\nPayments made via Online Banking Poland\n\\* trustly\
                        \ -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\
                        \\* cash_app_pay -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                      maxLength: 65000
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* dotpay -

                        dotpay
                        \* faster_payments - \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* google_pay -

                        google_pay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* ideal -

                        ideal
                        \* boleto -

                        boleto
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* grab_pay -

                        Payments made via GrabPay
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer - \* bancontact -

                        bancontact
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* swish -

                        Payments made via Swish
                        \* go_pay -

                        Payments made via GoPay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* venmo - \* alipay -

                        Payments made via Alipay.
                        \* pay_to - \* pay_co -

                        Payments made via PayCo
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* online_banking_poland -

                        Online Banking Poland
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for statement_descriptor
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)
                        text configured in the Chargebee site for all the subscription renewal transactions.
                      maxLength: 65000
                      example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                        of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                        is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                        is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                        See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      maxLength: 50
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>
                        ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        , the customer is not e-invoiced even if e-invoicing is enabled for their country.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      example: null
                    einvoicing_method:
                      type: string
                      deprecated: false
                      description: |
                        Determines whether to send einvoice manually or automatic.
                        \* automatic -

                        Use this value to send e-invoice every time an invoice or credit note is created.
                        \* manual -

                        When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
                        \* site_default -

                        The default value of the site which can be overridden at the customer level.
                      enum:
                      - automatic
                      - manual
                      - site_default
                      example: null
                    entity_identifier_standard:
                      type: string
                      default: iso6523-actorid-upis
                      deprecated: false
                      description: |-
                        <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
                        Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                        is supported and is used by default when not provided.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      maxLength: 50
                      example: null
                    business_customer_without_vat_number:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is a valid business without an EU/UK VAT number.
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">Amount that will override the Addon&#x27;s default price. The unit depends on the <a href="/docs/api/getting-started">type of currency</a>.
                        The Plan&#x27;s billing frequency will not be considered for overriding. E.g. If the Plan&#x27;s billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10 x 3). If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        is in the past and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addons[unit_price][i]</code>
                        is not passed, then the addon&#x27;s current unit price is considered even if the addon did not exist on the date as of when the change is scheduled.</p>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="https://www.chargebee.com/docs/price-override.html" target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon period. Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/getting-started">multi-decimal pricing</a>
                        is enabled. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        is in the past and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addons[unit_price_in_decimal][i]</code>
                        is not passed, then the addon&#x27;s current unit price is considered even if the addon did not exist on the date as of when the change is scheduled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. To update this value, redo the complete addon set using <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">replace_addon_list</code></a>.
                        (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        .)</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    proration_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Specifies how to manage charges or credits for the addon during this subscription update. It&#x27;s relevant only for addons that have their <code><a href="/docs/api/v2/pcv-1/addons/addon-object#pricing_model">pricing_model</a></code>
                          set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.
                          You may use this parameter only if the change to the subscription takes effect <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#change_option">immediately</a>.</p>
                          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                          <li class="text-base leading-relaxed">Once set, this parameter becomes a <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#addons_proration_type">subscription attribute</a> and automatically applies to any additional changes to the addon during the current term. It&#x27;s removed from the subscription attributes at renewal. You can&#x27;t alter this parameter&#x27;s value within the current term via later API calls.</li>
                          <li class="text-base leading-relaxed">If you don&#x27;t provide a value, Chargebee determines the proration logic based on the following precedence: this parameter &gt; <code><a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#prorate">prorate</a></code> parameter &gt; <code><a href="/docs/api/v2/pcv-1/addons/addon-object#proration_type">addon.proration_type</a></code> &gt; <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration</a> setting.</li>
                          </ul></div>
                          <span featureId="cb-addon-proration" isMicro="true"></span>
                          * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p>
                          * none - <p class="mb-2">Don&#x27;t apply any charges or credits for the addon.</p>
                          * full_term - <p class="mb-2">Charge the full price of the addon or give the full credit. Don&#x27;t apply any proration.</p>
                        enum:
                        - full_term
                        - partial_term
                        - none
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: <p class="mb-2">Resource object representing credit_note</p>
                    items:
                      $ref: "#/components/schemas/CreditNote"
                      description: Resource object representing credit_note
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/import_contract_term:
    post:
      summary: Import contract term
      description: |-
        <div class="api-description"><p class="mb-2">Import previous and active <a href="/docs/api/contract_terms">contract terms</a>
        .</p><p class="mb-2">For contract terms in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
        state, import is allowed only if the associated subscription is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
        .</p></div>
      operationId: import_contract_term
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                    .</p>
                  maximum: 100
                  minimum: 1
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Id that uniquely identifies the contract term in the site.
                      maxLength: 50
                      example: null
                    created_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date when the contract term was created.
                      example: null
                    contract_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The start date of the contract term
                      example: null
                    contract_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The end date of the contract term
                      example: null
                    status:
                      type: string
                      deprecated: false
                      description: |
                        Current status of contract
                        \* active -

                        An actively running contract term.
                        \* completed -

                        The contract term has run its full duration.
                        \* cancelled -

                        The contract term was ended because: - a change in the subscription caused a [subscription term reset](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#force_term_reset).

                        * the subscription was cancelled due to non-payment.

                        \* terminated -

                        The contract term was terminated ahead of completion.
                      enum:
                      - active
                      - completed
                      - cancelled
                      - terminated
                      example: null
                    total_amount_raised:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription. This amount
                        is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value</a></code></p>
                      minimum: 0
                      example: null
                    total_amount_raised_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: <p class="mb-2">The amount raised for the contract
                        term till the time of importing the subscription excluding
                        tax. This amount is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value_before_tax</a></code></p>
                      minimum: 0
                      example: null
                    total_contract_value:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
                        of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        contract terms, this is a predicted value. The value depends on the <a href="/docs/api/v2/pcv-1/subscriptions">type of currency</a>.
                        If the subscription was <a href="/docs/api/v2/pcv-1/subscriptions/import-a-subscription">imported</a>
                        with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
                        .</p>
                      minimum: 0
                      example: null
                    total_contract_value_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised_before_tax</code>
                        is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.</p>
                      minimum: 0
                      example: null
                    billing_cycle:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of billing cycles of the subscription that the contract term is for.
                      minimum: 0
                      example: null
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
              example: null
            encoding:
              contract_term:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  contract_term:
                    $ref: "#/components/schemas/ContractTerm"
                    description: <p class="mb-2">Resource object representing contract_term</p>
                required:
                - contract_term
                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: []
  /subscriptions/{subscription-id}/override_billing_profile:
    post:
      summary: Override Billing Profile
      description: "Assigns the payment source and sets auto collection state for\
        \ the subscription.  \nWhen you don't pass any input param for this API, payment\
        \ source and auto collection for the subscription will be the same as the\
        \ customer's default settings.\n"
      operationId: override_billing_profile
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique identifier of the payment source to be attached to this subscription.
                  maxLength: 40
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                    \* off -

                    Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                    \* on -

                    Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                  enum:
                  - "on"
                  - "off"
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - subscription
                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: []
  /subscriptions/{subscription-id}/remove_scheduled_pause:
    post:
      summary: Remove scheduled pause
      description: |
        If the subscription is in **Active** or **Non Renewing** state and is also scheduled to pause at the end_of_term/specific_date, this API can be used to remove the scheduled pause.
      operationId: remove_scheduled_pause
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/cancel:
    post:
      summary: Cancel a subscription
      description: |-
        <div class="api-description"><p class="mb-2">Cancelling a subscription will move the subscription from its current state to <strong class="font-semibold">Cancelled</strong>, and will stop all recurring actions.</p><p class="mb-2">You could schedule the cancellation by passing <strong class="font-semibold">end_of_term</strong> parameter as <strong class="font-semibold">true</strong>. If scheduled, the subscription status will be set to <strong class="font-semibold">non_renewing</strong> if it is in <strong class="font-semibold">active</strong> state, until the end of term, and then <strong class="font-semibold">cancelled</strong>. A subscription&#x27;s state will not change if it is in <strong class="font-semibold">in_trial</strong> state. However, cancellation will be scheduled at the end of the trial.</p><h4>CREDIT OPTION</h4><p class="mb-2">On subscription cancellation, credits can be issued against current term charges of the subscription by using <strong class="font-semibold">credit_option_for_current_term_charges</strong>. You can choose to either provide no credits, prorate credits for the unused period or issue full credits for the current term charges.</p><h4>UNBILLED CHARGES</h4><p class="mb-2">Any unbilled charges present in the subscription can either be invoiced or deleted by specifying <strong class="font-semibold">unbilled_charges_option</strong>. Note that automatic charge will be attempted on the payment method available if the customer has enabled auto-collection. If not, the invoice will be closed as unpaid.</p><h4>ACCOUNT RECEIVABLES</h4><p class="mb-2">Specifying <strong class="font-semibold">account_receivables_handling</strong> allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection or for writing off the due amount after applying the available credits and excess payments.</p><p class="mb-2">If specified as <strong class="font-semibold">schedule_payment_collection</strong>, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices. <strong class="font-semibold">Note:</strong> If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.</p><p class="mb-2">If specified as <strong class="font-semibold">write_off</strong>, the amount due of past invoices will be written-off. <strong class="font-semibold">Note:</strong> If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are still active(future, in-trial, active, and non-renewing), these invoices will not be selected for the write-off operation.</p><h4>ACCOUNT PAYABLES</h4><p class="mb-2">Specifying refundable_credits_handling allows you to provide refunds for refundable credits remaining, after they are applied to a subscription&#x27;s due invoices. The refund initiated will be asynchronous and the payment refunded event will be triggered on refund success. <strong class="font-semibold">Note:</strong> Consolidated credit notes of the subscription will not be selected for refund.</p><h4>Contract terms</h4><p class="mb-2">If the subscription has <a href="/docs/api/contract_terms">contract terms</a>, it can only be canceled by terminating the contract using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code>. The contract term and the subscription are canceled together.</p><h5>Contract terms parameters</h5><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#contract_term_cancel_option">contract_term_cancel_option</a></code>
        </li>
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#cancel_at">cancel_at</a></code>
        </li>
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#credit_option_for_current_term_charges">credit_option_for_current_term_charges</a></code>
        </li>
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#unbilled_charges_option">unbilled_charges_option</a></code>
        </li>
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#account_receivables_handling">account_receivables_handling</a></code>
        </li>
        <li class="text-base leading-relaxed">
        <code><a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#refundable_credits_handling">refundable_credits_handling</a></code>
        </li>
        </ul><div class="alert alert-info"><p class="mb-2">Advance charges, if any, will be refunded as credits.</p></div></div>
      operationId: cancel_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                cancel_option:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Determines when to cancel the subscription.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">This parameter is not applicable.</p>
                    * end_of_billing_term - <p class="mb-2">This is used to cancel a subscription either at the end of the advance term, if it&#x27;s billed for future renewals or at the end of its current billing cycle</p>
                    * end_of_term - <p class="mb-2">This is used to cancel a subscription at the end of the current billing cycle</p>
                    * immediately - <p class="mb-2">This is used to cancel the subscription with immediate effect</p>
                    * specific_date - <p class="mb-2">This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code></p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - end_of_billing_term
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">(Deprecated)</strong> Use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> instead.
                    Applicable only when the subscription does not have <a href="/docs/api/contract_terms">contract terms</a>.
                    Set this to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> changes to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                  example: null
                cancel_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies the date and time when the subscription should be canceled. Do not use this parameter when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_of_term</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>. Specifies the date and time to cancel the subscription and contract term.</p>
                    <h5>Backdating</h5>
                    <p class="mb-2">You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/backdating.html" target="_blank">Backdating</a> is enabled for subscription cancellation.</li>
                    <li class="text-base leading-relaxed">The current date does not exceed the <a href="https://www.chargebee.com/docs/1.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing" target="_blank">backdating limit configured in Chargebee Billing</a>.</li>
                    <li class="text-base leading-relaxed">The date is on or after the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</li>
                    <li class="text-base leading-relaxed">The date is on or after the most recent change involving:
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Addition/change/removal of plan or addon item prices.</li>
                    <li class="text-base leading-relaxed">Addition of charge item prices.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">The date is not more than one billing period into the past. For example, if the plan&#x27;s billing period is two months and today is April 14, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code> cannot be earlier than February 14.</li>
                    </ul>
                  example: null
                credit_option_for_current_term_charges:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle credits for current term charges when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle credits for current term charges when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * none - <p class="mb-2">No credits notes are created.</p>
                    * full - <p class="mb-2">Credits are issues for the full value of the current term charges.</p>
                    * prorate - <p class="mb-2">Prorated credits are issued.</p>
                  enum:
                  - none
                  - prorate
                  - full
                  example: null
                unbilled_charges_option:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle unbilled charges when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle unbilled charges when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * invoice - <p class="mb-2">An invoice is generated immediately with the unbilled charges.</p>
                    * delete - <p class="mb-2">The unbilled charges are deleted.</p>
                  enum:
                  - invoice
                  - delete
                  example: null
                account_receivables_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle past due invoices when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle past due invoices when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * no_action - <p class="mb-2">No action is taken.</p>
                    * write_off - <p class="mb-2">Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.
                    <em class="italic">Note: The credit note for the write-off is not included in the API response.</em></p>
                    * schedule_payment_collection - <p class="mb-2">Applies excess payments and refundable credits to past due invoices. If any amount remains and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>
                    , the remaining amount is automatically charged to the available payment method.</p>
                  enum:
                  - no_action
                  - schedule_payment_collection
                  - write_off
                  example: null
                refundable_credits_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle refundable credits when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle refundable credits when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * schedule_refund - <p class="mb-2">Refunds remaining credits after applying them to any past due invoices.</p>
                    * no_action - <p class="mb-2">No action is taken.</p>
                  enum:
                  - no_action
                  - schedule_refund
                  example: null
                contract_term_cancel_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.</p>
                    * terminate_immediately - <p class="mb-2">Cancels the subscription and contract term immediately. Sets the contract term&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminated</code> and collects any termination fee, if applicable.
                    To specify the termination fee, include a single object in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items</code> array. If not specified, the <a href="/docs/api/contract_terms">default termination fee</a> is applied (if configured).</p>
                    * end_of_contract_term - <p class="mb-2">Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.</p>
                    * specific_date - <p class="mb-2">Cancels the subscription and contract term on the date specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code>. Sets <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.
                    <strong class="font-semibold">Note</strong>: Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this option for your <a href="https://www.chargebee.com/docs/1.0/sites-intro.html">Chargebee site</a>.</p>
                    * end_of_subscription_billing_term - <p class="mb-2">Cancels the subscription and contract term at the end of the current billing cycle. Sets <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.
                    <strong class="font-semibold">Note</strong>: Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this option for your <a href="https://www.chargebee.com/docs/1.0/sites-intro.html">Chargebee site</a>.</p>
                  enum:
                  - terminate_immediately
                  - end_of_contract_term
                  - specific_date
                  - end_of_subscription_billing_term
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax</code>
                    configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code>.
                    .</li>
                    </ul>
                  example: null
                cancel_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the event-based addon that represents the termination fee.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The termination fee. In case it is quantity-based, this is the fee per unit.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        The service period of the termination fee-expressed in days-starting from the current date.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              event_based_addons:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: <p class="mb-2">Resource object representing credit_note</p>
                    items:
                      $ref: "#/components/schemas/CreditNote"
                      description: Resource object representing credit_note
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/charge_addon_at_term_end:
    post:
      summary: Charge addon at term end
      description: "Adds a \"non-recurring addon\" charge to a subscription which\
        \ will be added to the invoice generated at the end of the current term. If\
        \ there are any applicable coupons in the subscription, an appropriate discount\
        \ will be applied.\n\nTo collect the charges for the non-recurring addon immediately,\
        \ [use this API](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-non-recurring-addon).\
        \  \nIf any subscription changes happen before the end of the current term,\
        \ these charges will be collected along with it.\n"
      operationId: charge_addon_at_term_end
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                addon_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the non-recurring addon to be charged.
                  maxLength: 100
                  example: null
                addon_quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of addon units to be charged. Mandatory for quantity based addons.
                  minimum: 1
                  example: null
                addon_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                addon_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).
                    Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                addon_unit_price_in_decimal:
                  type: string
                  default: Addon Amount in Decimal
                  deprecated: false
                  description: |
                    When [price overriding](http://chargebee.com/docs/price-override.html )
                    is enabled for the site, the price or per-unit price of [the non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )
                    can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                    is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the addon starts.
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the addon ends.
                  example: null
              required:
              - addon_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/edit_advance_invoice_schedule:
    post:
      summary: Edit Advance Invoice Schedule
      description: |
        Modifies the [advance invoicing schedule](/docs/api/advance_invoice_schedules) for a subscription.
      operationId: edit_advance_invoice_schedule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles in one interval.
                  minimum: 1
                  example: null
                schedule_type:
                  type: string
                  deprecated: false
                  description: |
                    The type of advance invoice or advance invoicing schedule.
                    \* specific_dates -

                    Charge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).
                    For each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)
                    to charge for. Up to 5 dates can be configured.
                    \* fixed_intervals -

                    Charge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)
                    that constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)
                    that the invoice should be generated. Also specify [when the schedule should end](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_end_schedule_on)
                    .
                  enum:
                  - specific_dates
                  - fixed_intervals
                  example: null
                fixed_interval_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for fixed_interval_schedule
                  properties:
                    number_of_occurrences:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a>
                        of the subscription.  This parameter is applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">after_number_of_intervals</code></p>
                      minimum: 1
                      example: null
                    days_before_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before each interval that advance invoices are generated.
                      minimum: 1
                      example: null
                    end_schedule_on:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies when the schedule should end.</p>
                        * after_number_of_intervals - <p class="mb-2">Advance invoices are generated a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specified number of times</code></p>
                        * subscription_end - <p class="mb-2">Advance invoices are generated for as long as the subscription is active.</p>
                        * specific_date - <p class="mb-2">End the advance invoicing schedule on a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific date</code>
                        .</p>
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                        .</p>
                      example: null
                  example: null
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for specific_dates_schedule
                  properties:
                    id:
                      type: array
                      description: |
                        The [unique id](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#id)
                        of the member of the [advance_invoice_schedule](/docs/api/advance_invoice_schedules)
                        array which corresponds to the [specific_dates_schedule](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule)
                        that you intend to modify. Only applicable when [schedule_type](/docs/api/subscriptions/edit-advance-invoice-schedule#schedule_type)
                        is specific_dates.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    terms_to_charge:
                      type: array
                      description: |-
                        <p class="mb-2">The number of billing cycles to charge for, on the date specified. Applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is specific_dates.</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_dates</code>
                        .</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              fixed_interval_schedule:
                style: deepObject
                explode: true
              specific_dates_schedule:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  advance_invoice_schedules:
                    type: array
                    description: <p class="mb-2">Resource object representing advance_invoice_schedule</p>
                    items:
                      $ref: "#/components/schemas/AdvanceInvoiceSchedule"
                      description: Resource object representing advance_invoice_schedule
                    example: null
                required:
                - advance_invoice_schedules
                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: []
  /subscriptions/{subscription-id}/contract_terms:
    get:
      summary: List contract terms for a subscription
      description: |
        Retrieves a list of contract term resources for the subscription specified in the path.
      operationId: list_contract_terms_for_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending (earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        contract_term:
                          $ref: "#/components/schemas/ContractTerm"
                          description: Resource object representing contract_term
                      required:
                      - contract_term
                      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: []
  /subscriptions/{subscription-id}/pause:
    post:
      summary: Pause a subscription
      description: |-
        <div class="api-description"><p class="mb-2">Pauses the subscription, changing its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>. This prevents the subscription from getting renewed. No new charges are created until the subscription is resumed.</p><h4>Note:</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Applicable only for <strong class="font-semibold">active/non-renewing</strong> subscriptions.</li>
        <li class="text-base leading-relaxed">If paused indefinitely, the subscription is cancelled on the <code><a href="/docs/api/subscriptions/subscription-object#cancelled_at">cancelled_at</a></code> date.</li>
        <li class="text-base leading-relaxed">Advance charges, if any, are refunded as credits.</li>
        </ul></div>
      operationId: pause_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                pause_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">List of options to pause the subscription.</p>
                    * billing_cycles - <p class="mb-2">Pause at the end of the current term, and resume automatically after the set number of billing cycles (in <code><a href="/docs/api/subscriptions/pause-a-subscription#skip_billing_cycles">skip_billing_cycles</a></code>) have been skipped</p>
                    * immediately - <p class="mb-2">Pause immediately</p>
                    * end_of_term - <p class="mb-2">Pause at the end of current term</p>
                    * specific_date - <p class="mb-2">Pause on a specific date</p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - billing_cycles
                  example: null
                pause_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">Date on which the subscription will be paused. Applicable when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code> option is chosen in the <code><a href="/docs/api/subscriptions/pause-a-subscription#pause_option">pause_option</a></code> field.
                    For non-renewing subscriptions, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pause_date</code> should be before the cancellation date.</p>
                  example: null
                unbilled_charges_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Applicable when unbilled charges are present for the subscription and <code><a href="/docs/api/subscriptions/pause-a-subscription#pause_option">pause_option</a></code> is set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>. <strong class="font-semibold">Note:</strong> On the invoice raised, an automatic charge is attempted on the payment method available, if customer&#x27;s auto-collection property is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>.</p>
                    * invoice - <p class="mb-2">Invoice charges
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code> is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.</p>
                    * no_action - <p class="mb-2">Retain as unbilled
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">no_action</code> is chosen, charges are added to the resumption invoice.</p>
                  enum:
                  - no_action
                  - invoice
                  example: null
                invoice_dunning_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when <code><a href="/docs/api/subscriptions/pause-a-subscription#pause_option">pause_option</a></code> is set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>.
                    If invoice is in the dunning cycle, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_dunning_handing</code> allows you to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stop</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">continue</code> dunning.</p>
                    * continue - <p class="mb-2">Continue dunning</p>
                    * stop - <p class="mb-2">Stop dunning</p>
                  enum:
                  - continue
                  - stop
                  example: null
                skip_billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles that will be skipped. The subscription resumes after the set number of billing cycles have been skipped. This is applicable only when the value of  of <code><a href="/docs/api/subscriptions/pause-a-subscription#pause_option">pause_option</a></code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                    .</p>
                  minimum: 1
                  example: null
                resume_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
                    For non-renewing subscriptions,<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resume_date</code> should be before the cancellation date.</p>
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: <p class="mb-2">Resource object representing credit_note</p>
                    items:
                      $ref: "#/components/schemas/CreditNote"
                      description: Resource object representing credit_note
                    example: null
                required:
                - customer
                - subscription
                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: []
  /subscriptions/{subscription-id}/scheduled_changes:
    get:
      summary: Scheduled_changes a subscription_scheduled_change
      operationId: scheduled_changes_a_subscription_scheduled_change
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_scheduled_change:
                    $ref: "#/components/schemas/SubscriptionScheduledChange"
                    description: Resource object representing subscription_scheduled_change
                required:
                - subscription_scheduled_change
                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: []
  /subscriptions/{subscription-id}/update_scheduled_changes:
    post:
      summary: Update_scheduled_changes a subscription_scheduled_change
      operationId: update_scheduled_changes_a_subscription_scheduled_change
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                cancel_reason_code:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                action_type:
                  type: string
                  deprecated: false
                  enum:
                  - cancel
                  - pause
                  - reactivate
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_scheduled_change:
                    $ref: "#/components/schemas/SubscriptionScheduledChange"
                    description: Resource object representing subscription_scheduled_change
                required:
                - subscription_scheduled_change
                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: []
  /customers/{customer-id}/delete:
    post:
      summary: Delete a customer
      description: "Deletes a particular customer identified by the a unique identifier.\
        \  \nThis will delete the Payment Method from the gateway/vault. If you do\
        \ not want the Payment Method to be deleted from the vault, set the value\
        \ for the delete_payment_method parameter to false.\nThis operation is irreversible\
        \ - all data related to the customer, such as subscriptions, invoices, transactions,\
        \ and reports, will be deleted.\n**Note:** This operation schedules the customer\
        \ resource for deletion. It will be deleted in a few minutes.\n"
      operationId: delete_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                delete_payment_method:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Deletes the Payment Method from the gateway/vault.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/relationships:
    post:
      summary: Link a customer to an account hierarchy
      description: |-
        <div class="api-description"><p class="mb-2">Establish a <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html" target="_blank">hierarchical relationship</a> between customers. The path parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code> identifies the child in this relationship.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Prerequisite</strong>
        Both parent and child customers must be part of the same <a href="/docs/api/v2/pcv-1/advanced-features">business entity</a>.</p></div><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">A customer can have a maximum of 250 direct children.</li>
        <li class="text-base leading-relaxed">The hierarchy allows a maximum of 5 levels from the root node to the lowest child node.</li>
        </ul></div><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
        For the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">use_default_hierarchy_settings</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">parent_account_access</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">child_account_access</code> parameters below, the term &quot;parent&quot; usually refers to the customer with the ID <code><a href="/docs/api/v2/pcv-1/customers/link-a-customer#payment_owner_id">payment_owner_id</a></code>. However, if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_owner_id</code> is the same as the child&#x27;s ID (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{customer_id}</code>), the &quot;parent&quot; is identified by <code><a href="/docs/api/v2/pcv-1/customers/link-a-customer#parent_id">parent_id</a></code>.</p></div></div>
      operationId: link_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                parent_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">ID of the customer intended to be set as the immediate parent of the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
                    .</p>
                  maxLength: 50
                  example: null
                payment_owner_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                    of the customer responsible for paying the invoices for the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>.
                    This ID must match either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_owner_id</code>
                    .</p>
                  maxLength: 50
                  example: null
                invoice_owner_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                    of the customer who receives the invoice for charges incurred by the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>.
                    This ID must match either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
                    or one of its ancestors.</p>
                  maxLength: 50
                  example: null
                use_default_hierarchy_settings:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |-
                    <p class="mb-2">Decides if Chargebee should apply settings from the <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html#advanced-mode" target="_blank">Chargebee Billing UI</a> or from this API request.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: Chargebee uses settings configured in the Chargebee Billing UI.</li>
                    <li class="text-base leading-relaxed">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: Settings provided in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">parent_account_access</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">child_account_access</code> parameters are applied.</li>
                    </ul>
                  example: null
                parent_account_access:
                  type: object
                  deprecated: false
                  description: |
                    Settings for the parent account's access.
                  properties:
                    portal_edit_child_subscriptions:
                      type: string
                      deprecated: false
                      description: |
                        Determines the parent's access to the child's subscriptions in the Self-Serve Portal.
                        \* yes -

                        The parent can view and edit the child's subscriptions.
                        \* no -

                        The parent can't view or edit the child's subscriptions.
                        \* view_only -

                        The parent can only view the child's subscriptions.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    portal_download_child_invoices:
                      type: string
                      deprecated: false
                      description: |
                        Determines the parent's access to the child's invoices in the Self-Serve Portal.
                        \* no -

                        The parent can't view or download the child's invoices.
                        \* view_only -

                        The parent can view but not download the child's invoices.
                        \* yes -

                        The parent can both view and download the child's invoices.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    send_subscription_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent receives email notifications for the child&#x27;s subscriptions.</p>
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent receives email notifications for payment-related activities on the child&#x27;s invoices.</p>
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent receives email notifications for the child&#x27;s invoices.</p>
                      example: null
                  example: null
                child_account_access:
                  type: object
                  deprecated: false
                  description: |
                    Settings for the child account's access.
                  properties:
                    portal_edit_subscriptions:
                      type: string
                      deprecated: false
                      description: |
                        Determines the child's access to its own subscriptions in the Self-Serve Portal.
                        \* view_only -

                        The child account can only view its subscriptions.
                        \* yes -

                        The child account can view and edit its subscriptions.
                      enum:
                      - "yes"
                      - view_only
                      example: null
                    portal_download_invoices:
                      type: string
                      deprecated: false
                      description: |
                        Determines the child's access to its own invoices in the Self-Serve Portal.
                        \* yes -

                        The child account can both view and download its invoices.
                        \* view_only -

                        The child account can view but not download its invoices.
                        \* no -

                        The child account cannot view or download its own invoices.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    send_subscription_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for its subscriptions.</p>
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for payment-related activities for its invoices.</p>
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for its invoices.</p>
                      example: null
                  example: null
              example: null
            encoding:
              child_account_access:
                style: deepObject
                explode: true
              parent_account_access:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/delete_relationship:
    post:
      summary: Unlink a customer from its parent account
      description: |
        When a customer belongs to an [account hierarchy](https://www.chargebee.com/docs/1.0/account-hierarchy.html)
        , this operation detaches the customer from its parent. The hierarchy, if any, beneath the customer remains unchanged.
      operationId: delink_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/delete_contact:
    post:
      summary: Delete contacts for a customer
      description: |
        Deletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.
      operationId: delete_contacts_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contact
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Unique reference ID provided for the contact.
                      maxLength: 150
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              contact:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/assign_payment_role:
    post:
      summary: Assign payment role
      description: |
        Assign Primary or Backup payment role or unassign role for the payment source based on the preference for the payment collection.
      operationId: assign_payment_role
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source id this role will be assigned to.
                  maxLength: 40
                  example: null
                role:
                  type: string
                  deprecated: false
                  description: |
                    Indicates whether the payment source is Primary, Backup, or neither.
                    \* backup -

                    Backup
                    \* none -

                    None
                    \* primary -

                    Primary
                  enum:
                  - primary
                  - backup
                  - none
                  example: null
              required:
              - payment_source_id
              - role
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /customers/move:
    post:
      summary: Move a customer
      description: |-
        <div class="api-description"><p class="mb-2">This API copies a customer object from one site to another. The destination site (the site to which the customer is copied) is specified by the path parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{site}</code>; whereas, the source site (the site from which the customer is copied) is specified by the query parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">from_site</code>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Prerequisites</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">This endpoint is disabled by default. For the operation to work, the endpoint must be enabled for both the source and destination sites. Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to have it enabled.</li>
        <li class="text-base leading-relaxed">The customer&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">preferred_currency_code</code> must be enabled in the destination site.</li>
        </ul></div></div>
      operationId: move_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id_at_from_site:
                  type: string
                  deprecated: false
                  description: |
                    Id of the customer to be copied.
                  maxLength: 100
                  example: null
                from_site:
                  type: string
                  deprecated: false
                  description: |
                    Name of the site from which this customer need to be copied.
                  maxLength: 50
                  example: null
              required:
              - from_site
              - id_at_from_site
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  resource_migration:
                    $ref: "#/components/schemas/ResourceMigration"
                    description: <p class="mb-2">Resource object representing resource_migration</p>
                required:
                - resource_migration
                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: []
  /customers/{customer-id}/hierarchy:
    get:
      summary: Get account hierarchy for a customer
      description: |
        Retrieves the full or partial [account hierarchy](/docs/api/v2/pcv-1/hierarchies)
        for a customer.
      operationId: get_hierarchy
      parameters:
      - name: hierarchy_operation_type
        in: query
        description: |-
          <p class="mb-2">Specifies which part of the account hierarchy to retrieve for the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{customer_id}</code></p>
          * complete_hierarchy - <p class="mb-2">Retrieve all nodes in the account hierarchy.</p>
          * subordinates - <p class="mb-2">Retrieve all nodes in the account hierarchy that start from the specified customer (identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{customer_id}</code>
          ) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer.</p>
          * subordinates_with_unbilled_charges_payable_by_parent - <p class="mb-2">List all the nodes of the hierarchy formed by its subordinates with unbilled charges whose payment owner is the customer.</p>
          * path_to_root - <p class="mb-2">Retrieve nodes from the specified customer (identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{customer_id}</code>
          ) to the root of its account hierarchy.</p>
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - complete_hierarchy
          - subordinates
          - path_to_root
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hierarchies:
                    type: array
                    description: <p class="mb-2">Resource object representing hierarchy</p>
                    items:
                      $ref: "#/components/schemas/Hierarchy"
                      description: Resource object representing hierarchy
                    example: null
                required:
                - hierarchies
                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: []
  /customers/{customer-id}/update_payment_method:
    post:
      summary: Update payment method for a customer
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><a href="/docs/api/payment_sources">Payment Sources</a>
        comes with additional options and improvements to the <a href="/docs/api/cards">Card APIs</a>
        . For this operation, use the <a href="/docs/api/v2/pcv-1/payment_sources/create-using-gateway-temporary-token" target="_blank">Create using temporary token</a>
        API or <a href="/docs/api/payment_sources/create-using-permanent-token" target="_blank">Create using permanent token</a>
        API under Payment Sources to update payment method for the customer.</p></div><p class="mb-2">Updates payment method details for a customer.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        If you wish to pass the card number, CVV, or the single-use card tokens provided by gateways like Stripe, then use the <a href="/docs/api/cards/update-card-for-a-customer">Update card for a customer</a>
        API under Cards resource. This API is not supported for Chargebee Test Gateway, it is provided to help you understand the billing workflow in Chargebee.</p></div><p class="mb-2"><strong class="font-semibold">PayPal Express Checkout</strong>
        You can use this API if you are directly integrating PayPal Express Checkout in your website instead of using Chargebee&#x27;s hosted pages. When your customer updates his payment method using PayPal Express Checkout, you will be provided with the <em class="italic">Billing Agreement ID</em> by PayPal. You can update the payment method for that customer in Chargebee by passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paypal_express_checkout</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> with the <em class="italic">Billing Agreement ID</em>.</p><p class="mb-2"><strong class="font-semibold">Login and Pay with Amazon</strong>
        You can use this API if you are directly integrating <em class="italic">Login and Pay with Amazon</em> in your website instead of using Chargebee&#x27;s hosted pages. When your customer updates Amazon as a payment method, you will be provided with the <em class="italic">Billing Agreement ID</em> by Amazon. You can update the payment method for that customer in Chargebee by passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amazon_payments</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> with the <em class="italic">Billing Agreement ID</em>.</p><p class="mb-2"><strong class="font-semibold">Card Payments</strong>
        When the card details of your customer are stored in the vault of gateways such as Stripe or Braintree, you can use this API to update the <em class="italic">reference id</em> provided by them in Chargebee. To use this API, pass</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway</code> with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> with the identifier provided by the gateway/Spreedly to reference that specific card.</li>
        </ul><p class="mb-2"><strong class="font-semibold">Reference id format for Card Payments</strong>
        The format of reference_id will differ based on where the card is stored.</p><p class="mb-2"><strong class="font-semibold">Stripe:</strong> In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g. <em class="italic">cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G</em>). If you are passing Stripe Customer ID alone, then Chargebee will store the card marked as active for that customer in Stripe.</p><p class="mb-2"><strong class="font-semibold">Braintree:</strong> In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash
        (e.g. <em class="italic">cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G</em> ). If you are passing Braintree Customer ID alone, then Chargebee will store the card marked as default for that customer in Braintree.</p><p class="mb-2"><strong class="font-semibold">Spreedly Card vault:</strong> If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p><p class="mb-2"><strong class="font-semibold">Direct Debit Payments</strong>
        When the bank account details of your customer are stored in the gateway vault, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">direct_debit</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway</code> with the gateway where the bank account details are stored (e.g. <em class="italic">authorize_net</em>). If the gateway is not specified, the gateway supporting the direct debit will be used.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> with the identifier provided by the gateway to reference the customer&#x27;s bank account details.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tmp_token</code> with the single use token provided by the gateway ( Should be passed only if reference_id is not passed ).</li>
        </ul><p class="mb-2"><strong class="font-semibold">Reference id format for Direct Debit Payments</strong>
        The format of reference_id will differ based on where the bank account is stored.</p><p class="mb-2"><strong class="font-semibold">Stripe:</strong> In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Bank Account ID separated by forward slash
        (e.g. <em class="italic">cus_8suoHaLQH4G5AW/ba_18b8z2KmcbENlhgU03RznRYW</em>). If you are passing Stripe Customer ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Stripe.</p><p class="mb-2"><strong class="font-semibold">Authorize.Net:</strong> The reference_id consists of combination of Authorize.Net&#x27;s Customer Profile ID and Payment Profile ID separated by forward slash (e.g. <em class="italic">2384383/34834382</em>). If you are passing Authorize.Net&#x27;s Customer Profile ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Authorize.Net.</p><p class="mb-2"><strong class="font-semibold">GoCardless:</strong> The reference_id is the GoCardless Customer Mandate ID (e.g. <em class="italic">MD0077Z99TTQXK</em>).</p><p class="mb-2"><strong class="font-semibold">Note:</strong> While using this API to update payment method details, <a href="https://www.chargebee.com/docs/cards.html#card-verification">Card Verification</a> will not happen even if it is enabled for that particular gateway.</p></div>
      operationId: update_payment_method_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* sepa_instant_transfer -\n\nPayments made\
                        \ via Sepa Instant Transfer\n\\* direct_debit -\n\nRepresents\
                        \ bank account for which the direct debit or ACH agreement/mandate\
                        \ is created.\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * bancontact -\n\nPayments made via Bancontact Card.\n\\*\
                        \ dotpay -\n\nPayments made via Dotpay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* upi -\n\nUPI Payments.\n\\* google_pay\
                        \ -\n\nPayments made via Google Pay.\n\\* revolut_pay -\n\n\
                        Payments made via Revolut Pay.\n\\* amazon_payments -\n\n\
                        Payments made via Amazon Payments.\n\\* paypal_express_checkout\
                        \ -\n\nPayments made via PayPal Express Checkout.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* card -\n\nCard based\
                        \ payment including credit cards and debit cards. Details\
                        \ about the card can be obtained from the card resource.\n\
                        \\* ideal -\n\nPayments made via iDEAL.\n\\* pix -\n\nPayments\
                        \ made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* sofort -\n\nPayments\
                        \ made via Sofort.\n\\* alipay -\n\nPayments made via Alipay.\
                        \  \nThis payment source is deprecated.\n\\* twint -\n\nPayments\
                        \ made via Twint\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* netbanking_emandates -\n\nNetbanking\
                        \ (eMandates) Payments.\n\\* payme -\n\nPayments made via\
                        \ PayMe\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* online_banking_poland -\n\nPayments made via Online Banking\
                        \ Poland\n\\* pay_to -\n\nPayments made via PayTo\n\\* unionpay\
                        \ -\n\nPayments made via UnionPay.\n\\* faster_payments -\n\
                        \nPayments made via Faster Payments\n\\* pay_co -\n\nPayments\
                        \ made via PayCo\n\\* swish -\n\nPayments made via Swish\n\
                        \\* trustly -\n\nTrustly\n\\* venmo -\n\nPayments made via\
                        \ Venmo\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\\
                        * giropay -\n\nPayments made via giropay.\n\\* kakao_pay -\n\
                        \nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments\
                        \ made via WeChat Pay.  \nThis payment source is deprecated.\n\
                        \\* payconiq_by_bancontact -\n\nPayments made via Payconiq\
                        \ by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver\
                        \ Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use toke created by payment gateways. In Stripe, a single-use token is created for direct debit. In Braintree, a nonce is created for PayPal.
                      maxLength: 65000
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  required:
                  - type
                  example: null
              example: null
            encoding:
              payment_method:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}:
    get:
      summary: Retrieve a customer
      description: |
        Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.
      operationId: retrieve_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
    post:
      summary: Update a customer
      description: |
        Updates the customer resource. However, this method cannot be used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer. To update the same, use our [Update Billing Info](/docs/api/customers/update-billing-info-for-a-customer) API.
      operationId: update_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    First name of the customer.
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    Last name of the customer.
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    Email of the customer. Configured email notifications will be sent to this email.
                  maxLength: 70
                  example: null
                preferred_currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the customer. Applicable if Multicurrency is enabled.
                  maxLength: 3
                  example: null
                phone:
                  type: string
                  deprecated: false
                  description: |
                    Phone number of the customer.
                  maxLength: 50
                  example: null
                company:
                  type: string
                  deprecated: false
                  description: |
                    Company name of the customer.
                  maxLength: 250
                  example: null
                auto_collection:
                  type: string
                  default: "on"
                  deprecated: false
                  description: |
                    Whether payments needs to be collected automatically for this customer.
                    \* on -

                    Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
                    \* off -

                    Automatic collection of charges will not be made. All payments must be recorded offline.
                  enum:
                  - "on"
                  - "off"
                  example: null
                allow_direct_debit:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the customer can pay via Direct Debit.
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    The number of days within which the customer has to make payment for the invoice.
                  example: null
                taxability:
                  type: string
                  default: taxable
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies if the customer is liable for tax.</p>
                    * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                    In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                    * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                    <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                    </ul>
                  enum:
                  - taxable
                  - exempt
                  example: null
                exemption_details:
                  type: array
                  deprecated: false
                  description: |
                    Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)
                    .
                  items:
                    example: null
                  example: null
                customer_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* senior_citizen -

                    When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
                    \* industrial -

                    When the purchase is made by an industrial business
                    \* business -

                    When the purchase is made at a place of business
                    \* residential -

                    When the purchase is made by a customer for home use
                  enum:
                  - residential
                  - business
                  - senior_citizen
                  - industrial
                  example: null
                client_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  maxLength: 50
                  example: null
                taxjar_exemption_category:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration.
                    \* government -

                    Government
                    \* other -

                    Other
                    \* wholesale -

                    Whole-sale
                  enum:
                  - wholesale
                  - government
                  - other
                  example: null
                locale:
                  type: string
                  deprecated: false
                  description: |
                    Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                  maxLength: 50
                  example: null
                entity_code:
                  type: string
                  deprecated: false
                  description: |
                    The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                    .
                    \* med2 -

                    US Medical Device Excise Tax with taxable sales tax
                    \* med1 -

                    US Medical Device Excise Tax with exempt sales tax
                    \* d -

                    Foreign diplomat
                    \* e -

                    Charitable or benevolent organization
                    \* f -

                    Religious organization
                    \* g -

                    Resale
                    \* a -

                    Federal government
                    \* b -

                    State government
                    \* c -

                    Tribe/Status Indian/Indian Band
                    \* l -

                    Other or custom
                    \* m -

                    Educational organization
                    \* n -

                    Local government
                    \* h -

                    Commercial agricultural production
                    \* i -

                    Industrial production/manufacturer
                    \* j -

                    Direct pay permit
                    \* k -

                    Direct mail
                    \* p -

                    Commercial aquaculture
                    \* q -

                    Commercial Fishery
                    \* r -

                    Non-resident
                  enum:
                  - a
                  - b
                  - c
                  - d
                  - e
                  - f
                  - g
                  - h
                  - i
                  - j
                  - k
                  - l
                  - m
                  - "n"
                  - p
                  - q
                  - r
                  - med1
                  - med2
                  example: null
                exempt_number:
                  type: string
                  deprecated: false
                  description: |
                    Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                    .
                  maxLength: 100
                  example: null
                offline_payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The preferred offline payment method for the customer.
                    \* custom -

                    Custom
                    \* bank_transfer -

                    Bank Transfer
                    \* boleto -

                    Boleto
                    \* jp_automated_bank_transfer -

                    JP Automated Bank Transfer
                    \* sepa_credit -

                    SEPA Credit
                    \* cash -

                    Cash
                    \* check -

                    Check
                    \* mx_automated_bank_transfer -

                    MX Automated Bank Transfer
                    \* no_preference -

                    No Preference
                    \* us_automated_bank_transfer -

                    US Automated Bank Transfer
                    \* eu_automated_bank_transfer -

                    EU Automated Bank Transfer
                    \* ach_credit -

                    ACH Credit
                    \* uk_automated_bank_transfer -

                    UK Automated Bank Transfer
                  enum:
                  - no_preference
                  - cash
                  - check
                  - bank_transfer
                  - ach_credit
                  - sepa_credit
                  - boleto
                  - us_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - uk_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  - custom
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                auto_close_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)
                    for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)
                    which takes precedence.
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the customer. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                fraud_flag:
                  type: string
                  deprecated: false
                  description: |
                    Indicates whether or not the customer has been identified as fraudulent.
                    \* fraudulent -

                    The customer has been marked as fraudulent
                    \* suspicious -

                    The customer has been identified as potentially fraudulent by the gateway
                    \* safe -

                    The customer has been marked as safe
                  enum:
                  - safe
                  - fraudulent
                  example: null
                consolidated_invoicing:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the related tax field
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/hierarchy_detail:
    get:
      summary: Get paginated account hierarchy for a customer
      description: |
        Retrieves the [account hierarchy tree](/docs/api/hierarchies)
        for the customer.
      operationId: list_hierarchy_details
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Used for pagination. Set this to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          value from the previous API response to fetch the next page.</p>
        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.
          maxLength: 1000
          example: null
      - name: hierarchy_operation_type
        in: query
        description: |
          Specifies which part of the hierarchy to fetch. Choose from the available operation types.
          \* complete_hierarchy -

          Fetches all nodes in the full hierarchy that the customer belongs to.
          \* subordinates -

          Fetches all nodes in the sub-hierarchy rooted at the customer, including the customer and its subordinates.
          \* subordinates_with_unbilled_charges_payable_by_parent -

          Fetches subordinate nodes with [unbilled charges](/docs/api/customers/customer-object#unbilled_charges)
          for which the customer is the payment owner.
          \* path_to_root -

          Fetches a list of nodes along the path from the customer to the root of the hierarchy.
          \* immediate_children -

          Retrieves only the immediate children of the customer.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - complete_hierarchy
          - subordinates
          - path_to_root
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        hierarchy:
                          $ref: "#/components/schemas/Hierarchy"
                          description: Resource object representing hierarchy
                      required:
                      - hierarchy
                      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: []
  /customers/{customer-id}/change_billing_date:
    post:
      summary: Change billing date
      description: "Applicable when *calendar billing* (with customer specific billing\
        \ date support) is enabled. Changes the customer's *billing_date* and/or *billing_day_of_week*.\
        \  \nDuring this operation the upcoming renewal dates are **not** updated\
        \ to align immediately with the new date. The alignment will happen during\
        \ subsequent renewals.\nFor example, a customer's upcoming renewal is scheduled\
        \ for *January 10th* , when the customer's billing date is changed to the\
        \ *15th* , the next renewal date is still *January 10th* . The new billing\
        \ date does not take effect until the subsequent renewal, which in this case\
        \ is *February 15th* .\nIf you want to align with the new date immediately\
        \ (in this example: you want the next renewal to be on *January 15th* and\
        \ not *January 10th* ) you need to manually [change the subscription's term\
        \ end](/docs/api/subscriptions/change-term-end).\n"
      operationId: change_billing_date
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                billing_date:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Applicable when *calendar billing*
                    (with customer specific billing date support) is enabled. When set, renewals of all the monthly and yearly subscriptions of this customer will be aligned to this date.
                  maximum: 31
                  minimum: 1
                  example: null
                billing_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_month</code>, together with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code>, specify, for this customer, the day of the year when the renewals of all the year-based subscriptions take place.</p>
                    <p class="mb-2">For example, the renewals happen on 15th July when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_month</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">7</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">15</code>.</p>
                    <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    Applicable when <a href="https://www.chargebee.com/docs/calendar-billing.html" target="_blank">Calendar Billing</a> (with customer-specific billing date support) is enabled and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date_mode</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manually_set</code>.</p></div>
                  maximum: 12
                  minimum: 1
                  example: null
                billing_date_mode:
                  type: string
                  deprecated: false
                  description: |
                    Indicates whether this customer's *billing_date*
                    value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_date*
                    will not be reset even when all of the monthly/yearly subscriptions are cancelled.
                    \* manually_set -

                    Billing date is specifically set (default configuration is overridden)
                    \* using_defaults -

                    Billing date is set based on defaults configured.
                  enum:
                  - using_defaults
                  - manually_set
                  example: null
                billing_day_of_week:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when *calendar billing*
                    (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day.
                    \* sunday -

                    Sunday
                    \* wednesday -

                    Wednesday
                    \* tuesday -

                    Tuesday
                    \* monday -

                    Monday
                    \* saturday -

                    Saturday
                    \* friday -

                    Friday
                    \* thursday -

                    Thursday
                  enum:
                  - sunday
                  - monday
                  - tuesday
                  - wednesday
                  - thursday
                  - friday
                  - saturday
                  example: null
                billing_day_of_week_mode:
                  type: string
                  deprecated: false
                  description: |
                    Indicates whether this customer's *billing_day_of_week*
                    value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week*
                    will not be reset even when all of the weekly subscriptions are cancelled.
                    \* manually_set -

                    Billing date is specifically set (default configuration is overridden)
                    \* using_defaults -

                    Billing date is set based on defaults configured.
                  enum:
                  - using_defaults
                  - manually_set
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers:
    get:
      summary: List customers
      description: |
        Retrieves a list of customers added to your Chargebee site. The list contains the necessary customer details such as First Name, Last Name and the Customer ID.
      operationId: list_customers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted**
          ' attribute will be '**true**
          '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Identifier of the customer.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is_not\] = "9bsvnHgsvmsI"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 9bsvnHgsvmsI
          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: first_name
        in: query
        description: |
          optional, string filter

          First name of the customer.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *first_name\[is\] = "John"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: John
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: last_name
        in: query
        description: |
          optional, string filter

          Last name of the customer.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *last_name\[is\] = "Clint"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Clint
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: email
        in: query
        description: |
          optional, string filter

          Email of the customer. Configured email notifications will be sent to this email.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *email\[is\] = "john@test.com"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: john@test.com
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: company
        in: query
        description: |
          optional, string filter

          Company name of the customer.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *company\[is\] = "Globex Corp"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Globex Corp
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: phone
        in: query
        description: |
          optional, string filter

          Phone number of the customer.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *phone\[is\] = "(541) 754-3010"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: (541) 754-3010
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: auto_collection
        in: query
        description: |
          optional, enumerated string filter

          Whether payments needs to be collected automatically for this customer. Possible values are : on, off.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *auto_collection\[is\] = "on"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "on"
          properties:
            is:
              type: string
              description: |
                \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
              enum:
              - "on"
              - "off"
              example: null
            is_not:
              type: string
              description: |
                \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
              enum:
              - "on"
              - "off"
              example: null
            in:
              type: string
              description: |
                \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
              enum:
              - "on"
              - "off"
              pattern: "^\\[(on|off)(,(on|off))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
              enum:
              - "on"
              - "off"
              pattern: "^\\[(on|off)(,(on|off))*\\]$"
              example: null
      - name: taxability
        in: query
        description: |
          optional, enumerated string filter

          Specifies if the customer is liable for tax. Possible values are : taxable, exempt.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *taxability\[is\] = "taxable"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: taxable
          properties:
            is:
              type: string
              description: |-
                * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
              enum:
              - taxable
              - exempt
              example: null
            is_not:
              type: string
              description: |-
                * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
              enum:
              - taxable
              - exempt
              example: null
            in:
              type: string
              description: |-
                * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
              enum:
              - taxable
              - exempt
              pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
              enum:
              - taxable
              - exempt
              pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
              example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this customer resource is created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: updated_at
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
          This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
          input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
          for a faster response.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">updated_at[on] = &quot;1243545465&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: offline_payment_method
        in: query
        description: |
          optional, enumerated string filter

          The preferred offline payment method for the customer. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *offline_payment_method\[is\] = "cash"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: cash
          properties:
            is:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              example: null
            is_not:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              example: null
            in:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                ]$"
              example: null
      - name: auto_close_invoices
        in: query
        description: |
          optional, boolean filter

          Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)
          for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)
          which takes precedence. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *auto_close_invoices\[is\] = "true"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "true"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      - name: business_entity_id
        in: query
        description: "optional, string filter\n\nThe ID of the business entity created\
          \ for the site. For Product Catalog 1.0, all the site data is tied to this\
          \ business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started)\
          \ is a feature available only on Product Catalog 2.0.\n\n**Supported operators\
          \ :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is_not\\\
          ] = \"business_entity_id\"*\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: business_entity_id
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
          example: null
      - name: relationship
        in: query
        description: |
          Parameters for relationship
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            parent_id:
              type: object
              deprecated: false
              description: |
                Immediate parent with whom we will link our new customer(child)
              example: future_billing
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
            payment_owner_id:
              type: object
              deprecated: false
              description: |
                Parent who is going to pay
              example: active1
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
            invoice_owner_id:
              type: object
              deprecated: false
              description: |
                Parent who is going to handle invoices
              example: future_billing
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        customer:
                          $ref: "#/components/schemas/Customer"
                          description: Resource object representing customer
                        card:
                          $ref: "#/components/schemas/Card"
                          description: Resource object representing card
                      required:
                      - customer
                      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: []
    post:
      summary: Create a customer
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        This operation optionally supports 3DS verification flow. To achieve the same, create the <a href="/docs/api/v2/pcv-1/3ds_card_payments">Payment Intent</a>
        and pass it as input parameter to this API.</p></div><p class="mb-2">Creates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and card details.</p><p class="mb-2">Passing raw card data via API involves PCI liability at your end due to the sensitivity of the data. Instead, you can use one of the following integration options as applicable:</p><p class="mb-2">Here&#x27;s some resources you can use to collect card information within your checkout form based on the payment gateway you use:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://stripe.com/docs/js" target="_blank" rel="noopener noreferrer">Stripe.js</a> for Stripe users.</li>
        <li class="text-base leading-relaxed"><a href="https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2" target="_blank" rel="noopener noreferrer">Braintree.js</a> for Braintree users.</li>
        <li class="text-base leading-relaxed"><a href="https://developer.authorize.net/api/reference/features/acceptjs.html" target="_blank" rel="noopener noreferrer">Accept.js</a>, if you use <a href="https://www.authorize.net/" target="_blank">Authorize.Net</a>.</li>
        <li class="text-base leading-relaxed">If you are using the Adyen gateway, you will have to use the Adyen&#x27;s <a href="https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce" target="_blank">Client-Side Encryption</a> to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">adyen.encrypted.data</code>as temp token in this API.</li>
        <li class="text-base leading-relaxed">You can also use our <a href="https://www.chargebee.com/docs/1.0/hosted_pages.html" target="_blank">Hosted Pages</a> based integration.</li>
        </ul><p class="mb-2">When billing address is not passed (say, for customers making offline payments), you can always provide it later using the <a href="/docs/api/customers/update-billing-info-for-a-customer">Update billing info for a customer API</a>.</p><p class="mb-2"><strong class="font-semibold">Note:</strong> When an invoice is generated for a customer, the billing address provided for the customer is stored with the invoice. If the First Name, Last Name, and Company fields of the billing address do not contain any information, they&#x27;re picked up from the customer details.</p></div>
      operationId: create_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id for the new customer. If not given, this will be auto-generated.
                  maxLength: 50
                  example: null
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    First name of the customer.
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    Last name of the customer.
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    Email of the customer. Configured email notifications will be sent to this email.
                  maxLength: 70
                  example: null
                preferred_currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the customer. Applicable if Multicurrency is enabled.
                  maxLength: 3
                  example: null
                phone:
                  type: string
                  deprecated: false
                  description: |
                    Phone number of the customer.
                  maxLength: 50
                  example: null
                company:
                  type: string
                  deprecated: false
                  description: |
                    Company name of the customer.
                  maxLength: 250
                  example: null
                auto_collection:
                  type: string
                  default: "on"
                  deprecated: false
                  description: |
                    Whether payments needs to be collected automatically for this customer.
                    \* on -

                    Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
                    \* off -

                    Automatic collection of charges will not be made. All payments must be recorded offline.
                  enum:
                  - "on"
                  - "off"
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    The number of days within which the customer has to make payment for the invoice.
                  example: null
                allow_direct_debit:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the customer can pay via Direct Debit.
                  example: null
                vat_number:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                    can be overridden by setting
                    <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                    .</p>
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                    Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ).</p>
                    <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                    in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                    the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                    That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                    The first two characters of the VAT number in such a case is
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                    Set
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                    to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                    for such cases.</p>
                  maxLength: 10
                  example: null
                entity_identifier_scheme:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                    of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                    is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                    is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                    See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  maxLength: 50
                  example: null
                entity_identifier_standard:
                  type: string
                  default: iso6523-actorid-upis
                  deprecated: false
                  description: |-
                    <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
                    Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                    is supported and is used by default when not provided.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  maxLength: 50
                  example: null
                registered_for_gst:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                    is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                  example: null
                is_einvoice_enabled:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>
                    ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    , the customer is not e-invoiced even if e-invoicing is enabled for their country.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  example: null
                einvoicing_method:
                  type: string
                  deprecated: false
                  description: |
                    Determines whether to send einvoice manually or automatic.
                    \* automatic -

                    Use this value to send e-invoice every time an invoice or credit note is created.
                    \* manual -

                    When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
                    \* site_default -

                    The default value of the site which can be overridden at the customer level.
                  enum:
                  - automatic
                  - manual
                  - site_default
                  example: null
                taxability:
                  type: string
                  default: taxable
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies if the customer is liable for tax.</p>
                    * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                    In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                    * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                    <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                    </ul>
                  enum:
                  - taxable
                  - exempt
                  example: null
                exemption_details:
                  type: array
                  deprecated: false
                  description: |
                    Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)
                    .
                  items:
                    example: null
                  example: null
                customer_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* industrial -

                    When the purchase is made by an industrial business
                    \* residential -

                    When the purchase is made by a customer for home use
                    \* senior_citizen -

                    When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
                    \* business -

                    When the purchase is made at a place of business
                  enum:
                  - residential
                  - business
                  - senior_citizen
                  - industrial
                  example: null
                client_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  maxLength: 50
                  example: null
                taxjar_exemption_category:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration.
                    \* other -

                    Other
                    \* government -

                    Government
                    \* wholesale -

                    Whole-sale
                  enum:
                  - wholesale
                  - government
                  - other
                  example: null
                business_customer_without_vat_number:
                  type: boolean
                  deprecated: false
                  description: |
                    Confirms that a customer is a valid business without an EU/UK VAT number.
                  example: null
                locale:
                  type: string
                  deprecated: false
                  description: |
                    Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                  maxLength: 50
                  example: null
                entity_code:
                  type: string
                  deprecated: false
                  description: |
                    The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                    .
                    \* l -

                    Other or custom
                    \* m -

                    Educational organization
                    \* n -

                    Local government
                    \* h -

                    Commercial agricultural production
                    \* i -

                    Industrial production/manufacturer
                    \* j -

                    Direct pay permit
                    \* k -

                    Direct mail
                    \* p -

                    Commercial aquaculture
                    \* q -

                    Commercial Fishery
                    \* r -

                    Non-resident
                    \* d -

                    Foreign diplomat
                    \* e -

                    Charitable or benevolent organization
                    \* f -

                    Religious organization
                    \* g -

                    Resale
                    \* a -

                    Federal government
                    \* b -

                    State government
                    \* c -

                    Tribe/Status Indian/Indian Band
                    \* med2 -

                    US Medical Device Excise Tax with taxable sales tax
                    \* med1 -

                    US Medical Device Excise Tax with exempt sales tax
                  enum:
                  - a
                  - b
                  - c
                  - d
                  - e
                  - f
                  - g
                  - h
                  - i
                  - j
                  - k
                  - l
                  - m
                  - "n"
                  - p
                  - q
                  - r
                  - med1
                  - med2
                  example: null
                exempt_number:
                  type: string
                  deprecated: false
                  description: |
                    Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                    .
                  maxLength: 100
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the customer. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                offline_payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The preferred offline payment method for the customer.
                    \* sepa_credit -

                    SEPA Credit
                    \* cash -

                    Cash
                    \* no_preference -

                    No Preference
                    \* bank_transfer -

                    Bank Transfer
                    \* check -

                    Check
                    \* eu_automated_bank_transfer -

                    EU Automated Bank Transfer
                    \* jp_automated_bank_transfer -

                    JP Automated Bank Transfer
                    \* uk_automated_bank_transfer -

                    UK Automated Bank Transfer
                    \* custom -

                    Custom
                    \* boleto -

                    Boleto
                    \* mx_automated_bank_transfer -

                    MX Automated Bank Transfer
                    \* us_automated_bank_transfer -

                    US Automated Bank Transfer
                    \* ach_credit -

                    ACH Credit
                  enum:
                  - no_preference
                  - cash
                  - check
                  - bank_transfer
                  - ach_credit
                  - sepa_credit
                  - boleto
                  - us_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - uk_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  - custom
                  example: null
                auto_close_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)
                    for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)
                    which takes precedence.
                  example: null
                consolidated_invoicing:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The Chargebee payment token generated by <a href="https://www.chargebee.com/checkout-portal-docs/3ds-helper-overview.html#using-gateway-s-hosted-fields">Chargebee JS</a>.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:
                    The payment token created via Chargebee JS uses the gateway selected through <a href="https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing">Smart Routing</a>.
                    Explicitly passing a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway_id</code>
                    in this API call will not override the gateway associated with the token.</p></div>
                  maxLength: 40
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* visa -\n\nA Visa card scheme.\n\\* mada -\n\nA Mada card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                bank_account:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bank_account
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    iban:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's International Bank Account Number. For the [GoCardless](https://www.chargebee.com/docs/gocardless.html)
                        platform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
                      maxLength: 50
                      minLength: 10
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's first name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's last name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's company name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 250
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the account holder that is linked to the bank account.
                      maxLength: 50
                      example: null
                    bank_name:
                      type: string
                      deprecated: false
                      description: |
                        Name of account holder's bank.
                      maxLength: 100
                      example: null
                    account_number:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's bank account number.
                      maxLength: 17
                      minLength: 4
                      example: null
                    routing_number:
                      type: string
                      deprecated: false
                      description: |
                        Bank account routing number.
                      maxLength: 9
                      minLength: 3
                      example: null
                    bank_code:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the bank code.
                      maxLength: 20
                      example: null
                    account_type:
                      type: string
                      deprecated: false
                      description: |
                        Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/)
                        ACH and Razorpay NetBanking users only. If not passed, account type is taken as null.
                        \* checking -

                        Checking Account
                        \* business_checking -

                        Business Checking Account
                        \* savings -

                        Savings Account
                        \* current -

                        Current Account
                      enum:
                      - checking
                      - savings
                      - business_checking
                      - current
                      example: null
                    account_holder_type:
                      type: string
                      deprecated: false
                      description: |
                        For Stripe ACH users only. Indicates the account holder type.
                        \* individual -

                        Individual Account.
                        \* company -

                        Company Account.
                      enum:
                      - individual
                      - company
                      example: null
                    echeck_type:
                      type: string
                      deprecated: false
                      description: |
                        For Authorize.net ACH users only. Indicates the type of eCheck.
                        \* ppd -

                        Payment Authorization is prearranged between the customer and the merchant.
                        \* ccd -

                        Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
                        \* web -

                        Payment Authorization obtained from the customer via the internet.
                      enum:
                      - web
                      - ppd
                      - ccd
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |
                        [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)
                        ISO country code. Required when local bank details are provided, and not IBAN.
                      maxLength: 50
                      example: null
                    swedish_identity_number:
                      type: string
                      deprecated: false
                      description: |
                        For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
                      maxLength: 12
                      minLength: 10
                      example: null
                    billing_address:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address associated with the bank account. The value is a JSON object with the following keys and their values:-   <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">company_name</code>:(string, max chars=250) The company name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>:(string) The name of the country for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code>:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li>
                        </ul>
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made\
                        \ via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\
                        \nPayments made via Sofort.\n\\* twint -\n\nPayments made\
                        \ via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                        \ Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay\
                        \ -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* upi -\n\nUPI Payments.\n\\\
                        * revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments\
                        \ made via Alipay.  \nThis payment source is deprecated.\n\
                        \\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments\
                        \ made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\
                        \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                        \ -\n\nPayments made via WeChat Pay.  \nThis payment source\
                        \ is deprecated.\n\\* sepa_instant_transfer -\n\nPayments\
                        \ made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
                        \ made via Dotpay.\n\\* paypal_express_checkout -\n\nPayments\
                        \ made via PayPal Express Checkout.\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* faster_payments -\n\nPayments made via\
                        \ Faster Payments\n\\* swish -\n\nPayments made via Swish\n\
                        \\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* amazon_payments -\n\nPayments made via\
                        \ Amazon Payments.\n\\* card -\n\nCard based payment including\
                        \ credit cards and debit cards. Details about the card can\
                        \ be obtained from the card resource.\n\\* online_banking_poland\
                        \ -\n\nPayments made via Online Banking Poland\n\\* trustly\
                        \ -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\
                        \\* cash_app_pay -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                      maxLength: 65000
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* google_pay -

                        google_pay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* ideal -

                        ideal
                        \* boleto -

                        boleto
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* grab_pay -

                        Payments made via GrabPay
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* swish -

                        Payments made via Swish
                        \* go_pay -

                        Payments made via GoPay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* venmo -

                        Venmo
                        \* alipay -

                        Payments made via Alipay.
                        \* pay_to -

                        PayTo
                        \* pay_co -

                        Payments made via PayCo
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* online_banking_poland -

                        Online Banking Poland
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                        in Chargebee. When not provided, it is autogenerated.</p>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: |-
                        <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                        of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                        is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                        is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                        See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: |-
                        <p class="mb-2">The value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>.
                        This identifies the customer entity on the Peppol network. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">10101010-STO-10</code>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    standard:
                      type: array
                      description: |-
                        <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>.
                        Currently, only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                        is supported and is used by default when not provided.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the related tax field
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              bank_account:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/add_contact:
    post:
      summary: Add contacts to a customer
      description: |
        Adds the required contact to a customer. You can give the First Name, Last Name, Email ID and more details as input parameters to add them under the desired customer.
      operationId: add_contacts_to_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contact
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Unique reference ID provided for the contact.
                      maxLength: 150
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the contact.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the contact.
                      maxLength: 50
                      example: null
                    label:
                      type: string
                      deprecated: false
                      description: |
                        Label/Tag provided for contact.
                      maxLength: 50
                      example: null
                    enabled:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Contact enabled / disabled
                      example: null
                    send_billing_email:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether Billing Emails option is enabled for the contact.
                      example: null
                    send_account_email:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether Account Emails option is enabled for the contact.
                      example: null
                  required:
                  - email
                  example: null
              example: null
            encoding:
              contact:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/contacts:
    get:
      summary: List of contacts for a customer
      description: |
        This API retrieves all the contacts for a customer.
      operationId: list_of_contacts_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        contact:
                          $ref: "#/components/schemas/Contact"
                          description: Resource object representing contact
                      required:
                      - contact
                      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: []
  /customers/{customer-id}/clear_personal_data:
    post:
      summary: Clear Personal Data of a customer
      description: |
        Clear personal details of a customer using this API.
      operationId: clear_personal_data_of_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/merge:
    post:
      summary: Merge customers
      description: "This API moves a customer's payment methods, subscriptions, invoices,\
        \ credit notes, transactions, unbilled charges, and orders to another customer.\
        \ Events and email logs will not be moved. The API execution is asynchronous.\
        \  \n**Note**\n\n* Moving virtual bank accounts from one customer to another\
        \ is not supported in this API.\n* Merging customers from different [business\
        \ entities](/docs/api/getting-started) is not permitted.\n"
      operationId: merge_customers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                from_customer_id:
                  type: string
                  deprecated: false
                  description: |
                    From customer id.
                  maxLength: 50
                  example: null
                to_customer_id:
                  type: string
                  deprecated: false
                  description: |
                    To customer id.
                  maxLength: 50
                  example: null
              required:
              - from_customer_id
              - to_customer_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/collect_payment:
    post:
      summary: Collect payment for customer
      description: |
        **Note:**
        This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)
        and pass it as input parameter to this API.

        This API can be used to collect the payments for customer's **payment_due** and **not_paid** invoices. You can either choose to collect the payment from an existing payment source or a new payment source. You can choose to either retain or discard the new payment source, which is being used for payment. If the amount collected exceeds the invoice amount, the surplus will be counted in as excess payments.
      operationId: collect_payment_for_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount to be collected. If this parameter is not passed then the invoice(s) amount to collect will be collected.
                  minimum: 0
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source used for the payment.
                  maxLength: 40
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |
                    Token generated by Chargebee JS representing payment method details.
                  maxLength: 40
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                retain_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the payment source should be retained for the customer.
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* sepa_instant_transfer -\n\nPayments made\
                        \ via Sepa Instant Transfer\n\\* go_pay -\n\nPayments made\
                        \ via GoPay\n\\* dotpay -\n\nPayments made via Dotpay.\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* paypal_express_checkout\
                        \ -\n\nPayments made via PayPal Express Checkout.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* pix -\n\nPayments made via Pix\n\\\
                        * pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made\
                        \ via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\\
                        * electronic_payment_standard -\n\nElectronic Payment Standard\n\
                        \\* generic -\n\nPayments made via Generic Payment Method.\n\
                        \\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\
                        \\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\
                        \\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay\
                        \ -\n\nPayments made via UnionPay.\n\\* faster_payments -\n\
                        \nPayments made via Faster Payments\n\\* swish -\n\nPayments\
                        \ made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\
                        \\* giropay -\n\nPayments made via giropay.\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* automated_bank_transfer -\n\
                        \nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* upi -\n\nUPI Payments.\n\\* revolut_pay\
                        \ -\n\nPayments made via Revolut Pay.\n\\* amazon_payments\
                        \ -\n\nPayments made via Amazon Payments.\n\\* card -\n\n\
                        Card based payment including credit cards and debit cards.\
                        \ Details about the card can be obtained from the card resource.\n\
                        \\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay\
                        \ -\n\nPayments made via Alipay.  \nThis payment source is\
                        \ deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\\
                        * pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments\
                        \ made via PayCo\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button\
                        \ -\n\nKBC Payment Button\n\\* kakao_pay -\n\nPayments made\
                        \ via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat\
                        \ Pay.  \nThis payment source is deprecated.\n\\* cash_app_pay\
                        \ -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet or card details. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mada -\n\nA Mada card scheme.\n\\* mastercard\
                        \ -\n\nA MasterCard scheme.\n\\* visa -\n\nA Visa card scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* go_pay -

                        Payments made via GoPay
                        \* google_pay -

                        google_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* ideal -

                        ideal
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                invoice_allocations:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice_allocations
                  properties:
                    invoice_id:
                      type: array
                      description: |
                        Identifier for the invoice. Multiple invoices can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    allocation_amount:
                      type: array
                      description: |
                        Amount that will override the Invoice amount to be collected. If not specified Invoice amount to collect will be taken as default. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  required:
                  - invoice_id
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              invoice_allocations:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - customer
                - transaction
                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: []
  /customers/{customer-id}/record_excess_payment:
    post:
      summary: Record an excess payment for a customer
      description: |
        Use this API to record any [excess payments](https://www.chargebee.com/docs/customers.html#excess-payments) made by the customer, such as advance payments. Such payments will be automatically applied to the future invoices. It can also be [manually applied](https://www.chargebee.com/docs/invoice-operations.html#apply-excess-payments) to the existing *Not Paid* or *Payment Due* invoices.
      operationId: record_an_excess_payment_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the payment.
                  maxLength: 300
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    id:
                      type: string
                      deprecated: false
                      maxLength: 40
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The payment transaction amount
                      minimum: 0
                      example: null
                    currency_code:
                      type: string
                      deprecated: false
                      description: |
                        The currency code (ISO 4217 format) for the transaction.
                      maxLength: 3
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates when this transaction occurred.
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction</p>
                        * cash - <p class="mb-2">Cash</p>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * custom - <p class="mb-2">Custom</p>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * upi - <p class="mb-2">upi</p>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * trustly - <p class="mb-2">Trustly</p>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        The reference number for this transaction. e.g check number in case of 'check' payments.
                      maxLength: 100
                      example: null
                    custom_payment_method_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the custom payment method of this transaction.
                      maxLength: 50
                      example: null
                  required:
                  - amount
                  - date
                  - payment_method
                  example: null
              example: null
            encoding:
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - customer
                - transaction
                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: []
  /customers/{customer-id}/update_contact:
    post:
      summary: Update contacts for a customer
      description: |
        Updates the details of a contact for a customer. You can give the field data to be updated as input parameters along with the Contact ID to update it.
      operationId: update_contacts_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contact
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Unique reference ID provided for the contact.
                      maxLength: 150
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the contact.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the contact.
                      maxLength: 50
                      example: null
                    label:
                      type: string
                      deprecated: false
                      description: |
                        Label/Tag provided for contact.
                      maxLength: 50
                      example: null
                    enabled:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Contact enabled / disabled
                      example: null
                    send_billing_email:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether Billing Emails option is enabled for the contact.
                      example: null
                    send_account_email:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Whether Account Emails option is enabled for the contact.
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              contact:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/update_hierarchy_settings:
    post:
      summary: Update account hierarchy access settings for a customer
      description: |-
        <div class="api-description"><p class="mb-2">When the customer is part of an <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html" target="_blank">account hierarchy</a>, this operation updates the access privileges that both the customer and its parent have to the customer&#x27;s data.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Terminology</strong>
        The term &quot;parent&quot; usually refers to the customer with the ID <code><a href="/docs/api/v2/pcv-1/customers/customer-object#relationship_payment_owner_id">payment_owner_id</a></code>. However, if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_owner_id</code> is the same as the child&#x27;s ID (given by the path parameter), the &quot;parent&quot; is identified by <code><a href="/docs/api/v2/pcv-1/customers/customer-object#relationship_parent_id">parent_id</a></code>.</p></div><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</strong>
        You cannot use this endpoint to change the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">parent_id</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_owner_id</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_owner_id</code> for the customer. To change them, <a href="/docs/api/v2/pcv-1/customers/delink-a-customer">unlink the customer</a> and then call <a href="/docs/api/v2/pcv-1/customers/link-a-customer">Link a customer</a> with the updated values.</p></div></div>
      operationId: update_hierarchy_access_settings_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                use_default_hierarchy_settings:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |-
                    <p class="mb-2">Decides if Chargebee should apply settings from the <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html#advanced-mode" target="_blank">Chargebee Billing UI</a> or from this API request.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: Chargebee removes existing settings stored in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">parent_account_access</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">child_account_access</code> attributes of the customer. The settings configured in the Chargebee Billing UI apply for the customer.</li>
                    <li class="text-base leading-relaxed">If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: Chargebee replaces existing settings stored in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">parent_account_access</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">child_account_access</code> parameters with those passed in this API call. If any of those parameters are not passed, they remain unchanged for the customer.</li>
                    </ul>
                  example: null
                parent_account_access:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for parent_account_access
                  properties:
                    portal_edit_child_subscriptions:
                      type: string
                      deprecated: false
                      description: |
                        Sets parent's level of access to child subscriptions on the Self-Serve Portal.
                        \* yes -

                        The parent account can view and edit the subscriptions of the child account.
                        \* no -

                        The parent account cannot view or edit the subscriptions of the child account.
                        \* view_only -

                        The parent account can only view the subscriptions of the child account.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    portal_download_child_invoices:
                      type: string
                      deprecated: false
                      description: |
                        Sets parent's level of access to child invoices on the Self-Serve Portal.
                        \* yes -

                        The parent account can view and download the invoices of the child account.
                        \* no -

                        The parent account can neither view nor download the invoices of the child account.
                        \* view_only -

                        The parent account can only view the invoices of the child account.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    send_subscription_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent account will receive subscription-related emails sent to the child account.</p>
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent account will receive payment-related emails sent to the child account.</p>
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the parent account will receive invoice-related emails sent to the child account.</p>
                      example: null
                  example: null
                child_account_access:
                  type: object
                  deprecated: false
                  description: |
                    When the customer is part of an \[account hierarchy\](https://www.chargebee.com/docs/1.0/account-hierarchy.html) , this attribute defines the level of access that the customer has to its own information.
                  properties:
                    portal_edit_subscriptions:
                      type: string
                      deprecated: false
                      description: |
                        Determines the child's access to its own subscriptions in the Self-Serve Portal.
                        \* view_only -

                        The child account can only view its subscriptions.
                        \* yes -

                        The child account can view and edit its subscriptions.
                      enum:
                      - "yes"
                      - view_only
                      example: null
                    portal_download_invoices:
                      type: string
                      deprecated: false
                      description: |
                        Determines the child's access to its own invoices in the Self-Serve Portal.
                        \* view_only -

                        The child account can view but not download its invoices.
                        \* no -

                        The child account cannot view or download its own invoices.
                        \* yes -

                        The child account can both view and download its invoices.
                      enum:
                      - "yes"
                      - view_only
                      - "no"
                      example: null
                    send_subscription_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for its subscriptions.</p>
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for payment-related activities for its invoices.</p>
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the child account receives email notifications for its invoices.</p>
                      example: null
                  example: null
              example: null
            encoding:
              child_account_access:
                style: deepObject
                explode: true
              parent_account_access:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/update_billing_info:
    post:
      summary: Update billing info for a customer
      description: "<div class=\"api-description\"><p class=\"mb-2\">This method is\
        \ used for updating the <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >billing_address</code> and <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >vat_number</code> attributes of the <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">customer</code>. For updating the other customer attributes\
        \ use <a href=\"/docs/api/customers/update-a-customer\">Update Customer API</a>.</p><p\
        \ class=\"mb-2\">During this operation, if <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">billing_address</code> and <code class=\"bg-gray-100\
        \ text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1\
        \ text-sm font-mono whitespace-nowrap\">vat_number</code> are not already\
        \ present, they&#x27;re added. Whereas if present, the existing values are\
        \ replaced with the new values passed. The only exception here is for <code\
        \ class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded\
        \ px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">entity_identifiers[i]</code>\
        \ when <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">entity_identifiers[operation][i]</code>\
        \ is passed as <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >delete</code>.</p><p class=\"mb-2\"><strong class=\"font-semibold\">Note:</strong>\
        \ When an invoice is generated for a customer, the billing address provided\
        \ for the customer will be stored with the invoice. If the First Name, Last\
        \ Name, and Company fields do not contain any information under Billing Info,\
        \ the same will be picked from Customer Details if the same is available there.Please\
        \ ensure that the VAT number is provided whenever the billing address is updated,\
        \ as failing to do so will override any existing VAT numbers if new values\
        \ are not provided.</p></div>"
      operationId: update_billing_info_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                vat_number:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                    can be overridden by setting
                    <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                    .</p>
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                    Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ).</p>
                    <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                    in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                    the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                    That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                    The first two characters of the VAT number in such a case is
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                    Set
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                    to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                    for such cases.</p>
                  maxLength: 10
                  example: null
                entity_identifier_scheme:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                    of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                    is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                    is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                    See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  maxLength: 50
                  example: null
                entity_identifier_standard:
                  type: string
                  default: iso6523-actorid-upis
                  deprecated: false
                  description: |-
                    <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
                    Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                    is supported and is used by default when not provided.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  maxLength: 50
                  example: null
                registered_for_gst:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                    is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                  example: null
                business_customer_without_vat_number:
                  type: boolean
                  deprecated: false
                  description: |
                    Confirms that a customer is a valid business without an EU/UK VAT number.
                  example: null
                is_einvoice_enabled:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>
                    ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    , the customer is not e-invoiced even if e-invoicing is enabled for their country.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</p></div>
                    <span featureId="cb-einvoicing" isMicro="true"></span>
                  example: null
                einvoicing_method:
                  type: string
                  deprecated: false
                  description: |
                    Determines whether to send einvoice manually or automatic.
                    \* automatic -

                    Use this value to send e-invoice every time an invoice or credit note is created.
                    \* manual -

                    When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
                    \* site_default -

                    The default value of the site which can be overridden at the customer level.
                  enum:
                  - automatic
                  - manual
                  - site_default
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">E-Invoicing</strong></p><p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> is provided as different from the existing value and if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_standard</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code> already exist and are not provided for this operation, they&#x27;re cleared.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* invalid -

                        Address is invalid.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier[i]</code>
                        in Chargebee. This is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier[operation][i]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">update</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">delete</code>
                        .</p>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: |-
                        <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                        of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                        is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                        is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                        See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: |-
                        <p class="mb-2">The value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>.
                        This identifies the customer entity on the Peppol network. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">10101010-STO-10</code>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                        <span featureId="cb-einvoicing" isMicro="true"></span>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    operation:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">The operation to be performed for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                          .</p>
                          <span featureId="cb-einvoicing" isMicro="true"></span>
                          * update - <p class="mb-2">Updates an existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                          for the customer. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier[id]</code>
                          must be provided in this case.</p>
                          * delete - <p class="mb-2">Deletes an existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                          for the customer. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier[id]</code>
                          must be provided in this case.</p>
                          * create - <p class="mb-2">Creates a new <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                          for the customer.</p>
                        enum:
                        - create
                        - update
                        - delete
                        example: null
                      example: null
                    standard:
                      type: array
                      description: |-
                        <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>.
                        Currently, only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                        is supported and is used by default when not provided.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the related tax field
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - customer
                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: []
  /tokens/create_using_temp_token:
    post:
      summary: Create using vault temp token
      description: |
        Generate a token using the one time token created by payment gateways for any specific payment method.
      operationId: create_using_vault_temp_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account to which the token is associated.
                  maxLength: 50
                  example: null
                payment_method_type:
                  type: string
                  deprecated: false
                  description: "Type of payment method of the token.\n\\* google_pay\
                    \ -\n\nPayments made via Google Pay.\n\\* pay_co -\n\nPayments\
                    \ made via PayCo\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                    \\* unionpay -\n\nPayments made via UnionPay.\n\\* ideal -\n\n\
                    Payments made via iDEAL.\n\\* amazon_payments -\n\nPayments made\
                    \ via Amazon Payments.\n\\* bancontact -\n\nPayments made via\
                    \ Bancontact Card.\n\\* electronic_payment_standard -\n\nElectronic\
                    \ Payment Standard\n\\* grab_pay -\n\nPayments made via GrabPay\n\
                    \\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\
                    \\* trustly -\n\nTrustly\n\\* after_pay -\n\nPayments made via\
                    \ Afterpay\n\\* alipay -\n\nPayments made via Alipay.  \nThis\
                    \ payment source is deprecated.\n\\* card -\n\nCard based payment\
                    \ including credit cards and debit cards. Details about the card\
                    \ can be obtained from the card resource.\n\\* dotpay -\n\nPayments\
                    \ made via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\
                    \\* upi -\n\nUPI Payments.\n\\* sofort -\n\nPayments made via\
                    \ Sofort.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay -\n\n\
                    Payments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\
                    \\* direct_debit -\n\nRepresents bank account for which the direct\
                    \ debit or ACH agreement/mandate is created.\n\\* twint -\n\n\
                    Payments made via Twint\n\\* generic -\n\nPayments made via Generic\
                    \ Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\\
                    * wechat_pay -\n\nPayments made via WeChat Pay.  \nThis payment\
                    \ source is deprecated.\n\\* paypal_express_checkout -\n\nPayments\
                    \ made via PayPal Express Checkout.\n\\* kbc_payment_button -\n\
                    \nKBC Payment Button\n"
                  enum:
                  - card
                  - paypal_express_checkout
                  - amazon_payments
                  - direct_debit
                  - generic
                  - alipay
                  - unionpay
                  - apple_pay
                  - wechat_pay
                  - ideal
                  - google_pay
                  - sofort
                  - bancontact
                  - giropay
                  - dotpay
                  - upi
                  - netbanking_emandates
                  - venmo
                  - pay_to
                  - faster_payments
                  - sepa_instant_transfer
                  - automated_bank_transfer
                  - klarna_pay_now
                  - online_banking_poland
                  - payconiq_by_bancontact
                  - electronic_payment_standard
                  - kbc_payment_button
                  - pay_by_bank
                  - trustly
                  - stablecoin
                  - kakao_pay
                  - naver_pay
                  - revolut_pay
                  - cash_app_pay
                  - twint
                  - go_pay
                  - grab_pay
                  - pay_co
                  - after_pay
                  - swish
                  - payme
                  - pix
                  - klarna
                  example: null
                id_at_vault:
                  type: string
                  deprecated: false
                  description: |
                    Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                  maxLength: 65000
                  example: null
                gw_obj_type:
                  type: string
                  deprecated: false
                  description: |
                    Represents what type of object at gateway eg. "token" in case Stripe token and "source" in case of Stripe Source.
                  maxLength: 255
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    Used to derieve Bank Account Scheme by default will take site default currency.
                  maxLength: 3
                  example: null
                additional_information:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device
                    .</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    </ul>
                  example: null
                token_additional_detail:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for token_additional_detail
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                  example: null
                token_billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for token_billing_address
                  properties:
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    country_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                  example: null
              required:
              - id_at_vault
              - payment_method_type
              example: null
            encoding:
              token_additional_detail:
                style: deepObject
                explode: true
              token_billing_address:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    $ref: "#/components/schemas/Token"
                    description: <p class="mb-2">Resource object representing token</p>
                required:
                - token
                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: []
  /tokens/create_for_card:
    post:
      summary: Create a card payment method token
      description: |
        Generate a token that holds card related information.
      operationId: create_a_card_payment_method_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* mada -\n\nA Mada card scheme.\n\\* visa -\n\nA Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                    card_type:
                      type: string
                      deprecated: false
                      description: |
                        Type of the card
                        \* not_applicable -

                        Used for offline entries in transactions. Not applicable for cards
                        \* visa -

                        A Visa card.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* jcb -

                        A JCB card.
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* diners_club -

                        A Diner's Club card.
                        \* other -

                        Card belonging to types other than those listed above.
                        \* discover -

                        A Discover card.
                        \* american_express -

                        An American Express card.
                        \* bancontact -

                        A Bancontact card.
                        \* pay_by_bank -

                        Pay By Bank
                        \* mastercard -

                        A MasterCard.
                        \* trustly -

                        Trustly
                      enum:
                      - visa
                      - mastercard
                      - american_express
                      - discover
                      - jcb
                      - diners_club
                      - bancontact
                      - cmr_falabella
                      - tarjeta_naranja
                      - nativa
                      - cencosud
                      - cabal
                      - argencard
                      - elo
                      - hipercard
                      - carnet
                      - rupay
                      - maestro
                      - dankort
                      - cartes_bancaires
                      - mada
                      - other
                      - not_applicable
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      maxLength: 70
                      example: null
                  required:
                  - expiry_month
                  - expiry_year
                  - number
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    $ref: "#/components/schemas/Token"
                    description: <p class="mb-2">Resource object representing token</p>
                required:
                - token
                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: []
  /tokens/{cb-token-id}:
    get:
      summary: Retrieve a token
      description: |
        Retrieve a token using token ID.
      operationId: retrieve_a_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: cb-token-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cb-token-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    $ref: "#/components/schemas/Token"
                    description: <p class="mb-2">Resource object representing token</p>
                required:
                - token
                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: []
  /payment_sources/create_using_permanent_token:
    post:
      summary: Create using permanent token
      description: "This API provides an alternative way to create a payment source\
        \ using a permanent token, instead of having to add the full payment method\
        \ details via API or the Chargebee UI. Permanent tokens are provided by payment\
        \ gateways such as Stripe.  \nStoring card after successful 3DS completion\
        \ is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\n\
        under Payment source to store the card after successful 3DS flow completion.\n"
      operationId: create_using_permanent_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: "The type of payment method. For more details refer\
                    \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                    API under Customer resource.\n\\* direct_debit -\n\nRepresents\
                    \ bank account for which the direct debit or ACH agreement/mandate\
                    \ is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\
                    \\* google_pay -\n\nPayments made via Google Pay.\n\\* sepa_instant_transfer\
                    \ -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\
                    \nPayments made via Dotpay.\n\\* pay_to -\n\nPayments made via\
                    \ PayTo\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\
                    \\* naver_pay -\n\nPayments made via Naver Pay.\n\\* giropay -\n\
                    \nPayments made via giropay.\n\\* grab_pay -\n\nPayments made\
                    \ via GrabPay\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\
                    \\* alipay -\n\nPayments made via Alipay.  \nThis payment source\
                    \ is deprecated.\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\
                    \\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments\
                    \ made via Pix\n\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay\
                    \ -\n\nPayments made via WeChat Pay.  \nThis payment source is\
                    \ deprecated.\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                    \ Payments.\n\\* bancontact -\n\nPayments made via Bancontact\
                    \ Card.\n\\* go_pay -\n\nPayments made via GoPay\n\\* card -\n\
                    \nCard based payment including credit cards and debit cards. Details\
                    \ about the card can be obtained from the card resource.\n\\*\
                    \ amazon_payments -\n\nPayments made via Amazon Payments.\n\\\
                    * pay_by_bank -\n\nPay By Bank\n\\* after_pay -\n\nPayments made\
                    \ via Afterpay\n\\* faster_payments -\n\nPayments made via Faster\
                    \ Payments\n\\* generic -\n\nPayments made via Generic Payment\
                    \ Method.\n\\* payme -\n\nPayments made via PayMe\n\\* klarna_pay_now\
                    \ -\n\nPayments made via Klarna Pay Now\n\\* twint -\n\nPayments\
                    \ made via Twint\n\\* swish -\n\nPayments made via Swish\n\\*\
                    \ automated_bank_transfer -\n\nRepresents virtual bank account\
                    \ using which the payment will be done.\n\\* paypal_express_checkout\
                    \ -\n\nPayments made via PayPal Express Checkout.\n\\* venmo -\n\
                    \nPayments made via Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\
                    \\* trustly -\n\nTrustly\n\\* upi -\n\nUPI Payments.\n\\* kbc_payment_button\
                    \ -\n\nKBC Payment Button\n\\* cash_app_pay -\n\nPayments made\
                    \ via Cash App Pay.\n\\* payconiq_by_bancontact -\n\nPayments\
                    \ made via Payconiq by Bancontact.\n\\* apple_pay -\n\nPayments\
                    \ made via Apple Pay.\n\\* electronic_payment_standard -\n\nElectronic\
                    \ Payment Standard\n"
                  enum:
                  - card
                  - paypal_express_checkout
                  - amazon_payments
                  - direct_debit
                  - generic
                  - alipay
                  - unionpay
                  - apple_pay
                  - wechat_pay
                  - ideal
                  - google_pay
                  - sofort
                  - bancontact
                  - giropay
                  - dotpay
                  - upi
                  - netbanking_emandates
                  - venmo
                  - pay_to
                  - faster_payments
                  - sepa_instant_transfer
                  - automated_bank_transfer
                  - klarna_pay_now
                  - online_banking_poland
                  - payconiq_by_bancontact
                  - electronic_payment_standard
                  - kbc_payment_button
                  - pay_by_bank
                  - trustly
                  - stablecoin
                  - kakao_pay
                  - naver_pay
                  - revolut_pay
                  - cash_app_pay
                  - twint
                  - go_pay
                  - grab_pay
                  - pay_co
                  - after_pay
                  - swish
                  - payme
                  - pix
                  - klarna
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account to which the payment source is associated.
                  maxLength: 50
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The reference id. In the case of Amazon and PayPal, this will be the billing agreement ID. For GoCardless direct debit this will be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code>. In the case of a card, this will be the identifier provided by the gateway or card vault for the specific payment method resource.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">This is not the one-time temporary token provided by gateways like Stripe.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> is an alternative for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_profile_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">network_transaction_id</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_profile_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">network_transaction_id</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code> cannot be used with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> is a combination of multiple tokens available at the gateway. Learn more about the combination of each gateway from this <a href="/docs/api/payment_parameters">document</a>.</p>
                    </li>
                    </ul></div>
                  maxLength: 200
                  example: null
                issuing_country:
                  type: string
                  deprecated: false
                  description: |
                    2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                payment_method_token:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An identifier provided by the gateway or card vault for the specific payment method resource.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_token</code> is an alternative for reference_id and cannot be used with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p></div>
                  maxLength: 100
                  example: null
                customer_profile_token:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">A unique identifier associated with a customer`s profile within a payment gateway.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_profile_token</code> is an alternative for reference_id and cannot be used with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p></div>
                  maxLength: 100
                  example: null
                network_transaction_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An identifier of the payment or authorization transaction at the gateway initiated using this payment method.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">network_transaction_id</code> is an alternative for reference_id and cannot be used with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p></div>
                  maxLength: 100
                  example: null
                mandate_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An identifier of mandates which is an authorization given by the payer (usually a customer or account holder) to allow a third party such as a merchant or service provider to initiate payments from their account.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code> is an alternative for reference_id and cannot be used with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code>.</p></div>
                  maxLength: 100
                  example: null
                skip_retrieval:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">By default, the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> and payment method details will be retrieved from the selected payment gateway using <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_id</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_token</code> / <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_profile_token</code> / <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">network_transaction_id</code> / <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code>. Learn more about the multiple token combinations of each gateway from this <a href="/docs/api/payment_parameters">document</a>.
                    Enter the value as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> for the payment gateways that do not allow to retrieve the payment method details. Once passed, it will create payment method at Chargebee with the provided attributes in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_profile_token</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">network_transaction_id</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate_id</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    Currently, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skip_retrieval</code> value as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> is only supported for the Vantiv payment gateway.</p></div>
                  example: null
                additional_information:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://docs.checkout.com/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device
                    .</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    </ul>
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters of tokenized card details
                  properties:
                    last4:
                      type: string
                      deprecated: false
                      description: |
                        Last four digits of the card number
                      maxLength: 4
                      minLength: 4
                      example: null
                    iin:
                      type: string
                      deprecated: false
                      description: |
                        The Issuer Identification Number, i.e. the first six digits of the card number
                      maxLength: 6
                      minLength: 6
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    brand:
                      type: string
                      deprecated: false
                      description: |
                        Card brand
                        \* cabal -

                        A Cabal card.
                        \* cartes_bancaires -

                        A Cartes Bancaires card.
                        \* american_express -

                        An American Express card.
                        \* visa -

                        A Visa card.
                        \* cencosud -

                        A Cencosud card.
                        \* not_applicable -

                        Used for offline entries in transactions. Not applicable for cards
                        \* maestro -

                        A Maestro card.
                        \* carnet -

                        A Carnet card.
                        \* argencard -

                        An Argencard.
                        \* dankort -

                        A Dankort card.
                        \* tarjeta_naranja -

                        A Tarjeta Naranja card.
                        \* mastercard -

                        A MasterCard.
                        \* jcb -

                        A JCB card.
                        \* pay_by_bank -

                        Pay By Bank
                        \* hipercard -

                        An Hipercard.
                        \* other -

                        Card belonging to types other than those listed above.
                        \* trustly -

                        Trustly
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* bancontact -

                        A Bancontact card.
                        \* cmr_falabella -

                        A CMR Falabella card.
                        \* rupay -

                        A Rupay card.
                        \* nativa -

                        A Nativa card.
                        \* discover -

                        A Discover card.
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* elo -

                        A Elo card.
                        \* diners_club -

                        A Diner's Club card.
                        \* mada -

                        A Mada card.
                      enum:
                      - visa
                      - mastercard
                      - american_express
                      - discover
                      - jcb
                      - diners_club
                      - other
                      - bancontact
                      - cmr_falabella
                      - tarjeta_naranja
                      - nativa
                      - cencosud
                      - cabal
                      - argencard
                      - elo
                      - hipercard
                      - carnet
                      - rupay
                      - maestro
                      - dankort
                      - cartes_bancaires
                      - mada
                      example: null
                    funding_type:
                      type: string
                      deprecated: false
                      description: |
                        Card Funding type
                        \* not_known -

                        An unknown card.
                        \* debit -

                        A debit card.
                        \* credit -

                        A credit card.
                        \* prepaid -

                        A prepaid card.
                        \* not_applicable -

                        Used for ACH. Not applicable for cards
                      enum:
                      - credit
                      - debit
                      - prepaid
                      - not_known
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                  example: null
              required:
              - customer_id
              - type
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/delete:
    post:
      summary: Delete a payment source
      description: "Deletes a payment source. Once the payment source is deleted,\
        \ if\n\n* **Deleted payment source is Primary, and Backup is available**\n\
        \  * The Backup payment source will become the Primary payment source.\n*\
        \ **Deleted payment source is Primary, and no Backup is available**\n  * The\
        \ other payment source available, but not assigned to any subscription, will\
        \ become the Primary payment source.\n\n    **Note** : *When multiple payment\
        \ sources exist, the payment method added most recently will be considered*.\n\
        \  * If other payment sources available are assigned to subscriptions, the\
        \ auto collection attribute for the customer will be set to Off, and the events\
        \ *card_deleted* and *payment_source_deleted* will be triggered.\n\n* **Deleted\
        \ payment source is attached to subscriptions**\n  * Dunning will be initiated\
        \ for subscriptions attached to this payment source if auto collection is\
        \ set to On, and when no customer default is present.\n\nIf there is no such\
        \ payment source present in the gateway for the customer, this API will return\
        \ successfully without throwing any error.  \n**Note**\n:\n\nIf you delete\
        \ the only available payment method of a customer in Chargebee, it also deletes\
        \ the customer's record at the gateway. To delete the payment method locally(delete\
        \ only in Chargebee), use [Local Delete a Payment Source API](/docs/api/payment_sources/local-delete-a-payment-source)\n\
        .\n"
      operationId: delete_a_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/create_card:
    post:
      summary: Create a card payment source
      description: |
        Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)
        under Payment source to store the card after successful 3DS flow completion.
      operationId: create_a_card_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* mastercard -\n\nA MasterCard scheme.\n\\\
                        * mada -\n\nA Mada card scheme.\n\\* cartes_bancaires -\n\n\
                        A Cartes Bancaires card scheme.\n\\* visa -\n\nA Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  required:
                  - expiry_month
                  - expiry_year
                  - number
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/verify_bank_account:
    post:
      summary: Verify bank account payment source
      description: "This API can be used to verify bank accounts which have been added\
        \ as payment source. This is applicable for **Stripe ACH with micro-deposit\
        \ mode bank accounts** only. Stripe handles verification in two ways - via\
        \ Plaid, and micro-deposit.\n\nFor verifying bank accounts via **micro-deposit**,\
        \ Stripe deposits two small amounts to the bank account being added. These\
        \ deposits will take 1-2 business days to appear on the customer's bank statement.\
        \ The bank statement description for the two micro-deposits contains the amount\
        \ and the values deposited. Your customer will need to relay the value of\
        \ the two deposits to you, after which you can verify the bank account. Once\
        \ the bank account has been verified, the payment source will be marked as\
        \ \"Valid\".  \nA maximum of 10 failed verification attempts are allowed.\
        \ Once this limit has been crossed, the bank account can no longer be verified,\
        \ and will be marked as \"Invalid\" in Chargebee.\n"
      operationId: verify_bank_account_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount1:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Value of the micro-deposits sent to the bank account.
                  minimum: 0
                  example: null
                amount2:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Value of the micro-deposits sent to the bank account.
                  minimum: 0
                  example: null
              required:
              - amount1
              - amount2
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - payment_source
                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: []
  /payment_sources:
    get:
      summary: List payment sources
      description: |
        Lists all the payment sources
      operationId: list_payment_sources
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: subscription_id
        in: query
        description: |-
          <p class="mb-2">Unique subscription identifier that helps to retrieve the payment source of a subscription which has <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">mandate</code>
          associated to it.</p>
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: include_deleted
        in: query
        description: |-
          <p class="mb-2">Indicates whether to include deleted objects in the list. The deleted objects have the attribute &#x27;<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">deleted</code>
          &#x27; as &#x27;<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
          &#x27;.</p>
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          To filter based on Customer Id.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is_not\] = "3bdjnDnsdQn"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 3bdjnDnsdQn
          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: type
        in: query
        description: |
          optional, enumerated string filter

          Type of payment source. Possible values are : card, paypal_express_checkout, amazon_payments, direct_debit, generic, alipay, unionpay, apple_pay, wechat_pay, ideal, google_pay, sofort, bancontact, giropay, dotpay, upi, netbanking_emandates.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *type\[is\] = "card"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: card
          properties:
            is:
              type: string
              description: |
                \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna
              enum:
              - card
              - paypal_express_checkout
              - amazon_payments
              - direct_debit
              - generic
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - upi
              - netbanking_emandates
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              example: null
            is_not:
              type: string
              description: |
                \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna
              enum:
              - card
              - paypal_express_checkout
              - amazon_payments
              - direct_debit
              - generic
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - upi
              - netbanking_emandates
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              example: null
            in:
              type: string
              description: |
                \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna
              enum:
              - card
              - paypal_express_checkout
              - amazon_payments
              - direct_debit
              - generic
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - upi
              - netbanking_emandates
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna)(,(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna
              enum:
              - card
              - paypal_express_checkout
              - amazon_payments
              - direct_debit
              - generic
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - upi
              - netbanking_emandates
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna)(,(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna))*\\\
                ]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Current status of the payment source. Possible values are : valid, expiring, expired, invalid, pending_verification.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "valid"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: valid
          properties:
            is:
              type: string
              description: |
                \* \`valid\` - A payment source that is valid and active. \* \`expiring\` - A payment source that is expiring (like card's status based on its expiry date). \* \`expired\` - A payment source that has expired \* \`invalid\` - The billing agreement cannot be used. It might become valid again either automatically or due to customer action. \* \`pending_verification\` - The payment source needs to be verified
              enum:
              - valid
              - expiring
              - expired
              - invalid
              - pending_verification
              example: null
            is_not:
              type: string
              description: |
                \* \`valid\` - A payment source that is valid and active. \* \`expiring\` - A payment source that is expiring (like card's status based on its expiry date). \* \`expired\` - A payment source that has expired \* \`invalid\` - The billing agreement cannot be used. It might become valid again either automatically or due to customer action. \* \`pending_verification\` - The payment source needs to be verified
              enum:
              - valid
              - expiring
              - expired
              - invalid
              - pending_verification
              example: null
            in:
              type: string
              description: |
                \* \`valid\` - A payment source that is valid and active. \* \`expiring\` - A payment source that is expiring (like card's status based on its expiry date). \* \`expired\` - A payment source that has expired \* \`invalid\` - The billing agreement cannot be used. It might become valid again either automatically or due to customer action. \* \`pending_verification\` - The payment source needs to be verified
              enum:
              - valid
              - expiring
              - expired
              - invalid
              - pending_verification
              pattern: "^\\[(valid|expiring|expired|invalid|pending_verification)(,(valid|expiring|expired|invalid|pending_verification))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`valid\` - A payment source that is valid and active. \* \`expiring\` - A payment source that is expiring (like card's status based on its expiry date). \* \`expired\` - A payment source that has expired \* \`invalid\` - The billing agreement cannot be used. It might become valid again either automatically or due to customer action. \* \`pending_verification\` - The payment source needs to be verified
              enum:
              - valid
              - expiring
              - expired
              - invalid
              - pending_verification
              pattern: "^\\[(valid|expiring|expired|invalid|pending_verification)(,(valid|expiring|expired|invalid|pending_verification))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this payment source resource was last updated.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this payment source resource is created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        payment_source:
                          $ref: "#/components/schemas/PaymentSource"
                          description: Resource object representing payment_source
                      required:
                      - payment_source
                      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: []
  /payment_sources/{cust-payment-source-id}/export_payment_source:
    post:
      summary: Export payment source
      description: "Copies this payment source information to the gateway specified\
        \ in the API.\n\nThis is useful if you want to port your customer's card details\
        \ into another gateway.  \nThis operation does not support copying of cards\
        \ from Stripe and Braintree gateways. If you need help using this API, contact\
        \ [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).\n"
      operationId: export_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account you want to copy the card.
                  maxLength: 50
                  example: null
              required:
              - gateway_account_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  third_party_payment_method:
                    $ref: "#/components/schemas/ThirdPartyPaymentMethod"
                    description: <p class="mb-2">Resource object representing third_party_payment_method</p>
                required:
                - third_party_payment_method
                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: []
  /payment_sources/create_using_payment_intent:
    post:
      summary: Create using payment intent
      description: |
        Used to attach the card to the customer after 3DS completion. [Learn more](/docs/api/3ds_card_payments)
        on the 3DS implementation via Chargebee APIs.
      operationId: create_using_payment_intent
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* payme -

                        Payments made via PayMe
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* go_pay -

                        Payments made via GoPay
                        \* pay_by_bank -

                        Pay By Bank
                        \* google_pay -

                        google_pay
                        \* apple_pay -

                        apple_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* giropay -

                        giropay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* ideal -

                        ideal
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_info:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">Applicable only for Braintree gateway. Can be used only for Braintree&#x27;s <a href="https://developer.paypal.com/braintree/articles/guides/fraud-tools/premium/overview" target="_blank">Premium Fraud Management Tools</a>.
                        Pass a stringified JSON containing the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>
                        and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>
                        as an input to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fingerprint</code>.
                        Here&#x27;s a <a href="/docs/api/payment_parameters" target="_blank">sample</a>
                        to it.</p>
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              payment_intent:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}:
    get:
      summary: Retrieve a payment source
      description: |
        Retrieves the payment source identified by the unique identifier.
      operationId: retrieve_a_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - payment_source
                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: []
  /payment_sources/create_voucher_payment_source:
    post:
      summary: Create a voucher payment method
      description: |
        Create a voucher payment method for the payment source.
      operationId: create_a_voucher_payment_method
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                voucher_payment_source:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for voucher_payment_source
                  properties:
                    voucher_type:
                      type: string
                      deprecated: false
                      description: |
                        Voucher based payment methods
                        \* boleto -

                        Boleto
                      enum:
                      - boleto
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account to which the payment method is associated.
                      maxLength: 50
                      example: null
                    tax_id:
                      type: string
                      deprecated: false
                      description: |
                        Customer Tax id
                      maxLength: 20
                      example: null
                    billing_address:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address of the customer. The value is a JSON object with the following keys and their values:-   <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix.For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li>
                        </ul>
                      example: null
                  required:
                  - voucher_type
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              voucher_payment_source:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/create_using_temp_token:
    post:
      summary: Create using gateway temporary token
      description: "This API offers an alternative way to create a payment source\
        \ using a single-use gateway temporary token, which is generally provided\
        \ by your payment gateway. In the case of Stripe, this temporary token is\
        \ generated according to the instruction detailed in [Stripe documentation](https://stripe.com/docs/api/tokens/create_card).\
        \  \nStoring card after successful 3DS completion is not supported in this\
        \ API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\n\
        under Payment source to store the card after successful 3DS flow completion.\n"
      operationId: create_using_gateway_temporary_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account to which the payment source is associated.
                  maxLength: 50
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: "Type of payment source.\n\\* automated_bank_transfer\
                    \ -\n\nRepresents virtual bank account using which the payment\
                    \ will be done.\n\\* direct_debit -\n\nRepresents bank account\
                    \ for which the direct debit or ACH agreement/mandate is created.\n\
                    \\* unionpay -\n\nPayments made via UnionPay.\n\\* after_pay -\n\
                    \nPayments made via Afterpay\n\\* stablecoin -\n\nPayments made\
                    \ via Stablecoin.\n\\* paypal_express_checkout -\n\nPayments made\
                    \ via PayPal Express Checkout.\n\\* alipay -\n\nPayments made\
                    \ via Alipay.  \nThis payment source is deprecated.\n\\* venmo\
                    \ -\n\nPayments made via Venmo\n\\* kakao_pay -\n\nPayments made\
                    \ via Kakao Pay.\n\\* sofort -\n\nPayments made via Sofort.\n\\\
                    * pix -\n\nPayments made via Pix\n\\* faster_payments -\n\nPayments\
                    \ made via Faster Payments\n\\* google_pay -\n\nPayments made\
                    \ via Google Pay.\n\\* pay_co -\n\nPayments made via PayCo\n\\\
                    * wechat_pay -\n\nPayments made via WeChat Pay.  \nThis payment\
                    \ source is deprecated.\n\\* ideal -\n\nPayments made via iDEAL.\n\
                    \\* trustly -\n\nTrustly\n\\* netbanking_emandates -\n\nNetbanking\
                    \ (eMandates) Payments.\n\\* sepa_instant_transfer -\n\nPayments\
                    \ made via Sepa Instant Transfer\n\\* upi -\n\nUPI Payments.\n\
                    \\* dotpay -\n\nPayments made via Dotpay.\n\\* bancontact -\n\n\
                    Payments made via Bancontact Card.\n\\* pay_to -\n\nPayments made\
                    \ via PayTo\n\\* go_pay -\n\nPayments made via GoPay\n\\* revolut_pay\
                    \ -\n\nPayments made via Revolut Pay.\n\\* kbc_payment_button\
                    \ -\n\nKBC Payment Button\n\\* naver_pay -\n\nPayments made via\
                    \ Naver Pay.\n\\* card -\n\nCard based payment including credit\
                    \ cards and debit cards. Details about the card can be obtained\
                    \ from the card resource.\n\\* cash_app_pay -\n\nPayments made\
                    \ via Cash App Pay.\n\\* generic -\n\nPayments made via Generic\
                    \ Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\\
                    * payconiq_by_bancontact -\n\nPayments made via Payconiq using\
                    \ Bancontact.\n\\* amazon_payments -\n\nPayments made via Amazon\
                    \ Payments.\n\\* giropay -\n\nPayments made via giropay.\n\\*\
                    \ klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* pay_by_bank\
                    \ -\n\nPay By Bank\n\\* grab_pay -\n\nPayments made via GrabPay\n\
                    \\* apple_pay -\n\nPayments made via Apple Pay.\n\\* electronic_payment_standard\
                    \ -\n\nElectronic Payment Standard\n\\* twint -\n\nPayments made\
                    \ via Twint\n\\* swish -\n\nPayments made via Swish\n"
                  enum:
                  - card
                  - paypal_express_checkout
                  - amazon_payments
                  - direct_debit
                  - generic
                  - alipay
                  - unionpay
                  - apple_pay
                  - wechat_pay
                  - ideal
                  - google_pay
                  - sofort
                  - bancontact
                  - giropay
                  - dotpay
                  - upi
                  - netbanking_emandates
                  - venmo
                  - pay_to
                  - faster_payments
                  - sepa_instant_transfer
                  - automated_bank_transfer
                  - klarna_pay_now
                  - online_banking_poland
                  - payconiq_by_bancontact
                  - electronic_payment_standard
                  - kbc_payment_button
                  - pay_by_bank
                  - trustly
                  - stablecoin
                  - kakao_pay
                  - naver_pay
                  - revolut_pay
                  - cash_app_pay
                  - twint
                  - go_pay
                  - grab_pay
                  - pay_co
                  - after_pay
                  - swish
                  - payme
                  - pix
                  - klarna
                  example: null
                tmp_token:
                  type: string
                  deprecated: false
                  description: |
                    Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                  maxLength: 65000
                  example: null
                issuing_country:
                  type: string
                  deprecated: false
                  description: |
                    2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                additional_information:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://docs.checkout.com/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device
                    .</li>
                    </ul>
                    </li>
                    </ul>
                    </li>
                    </ul>
                  example: null
              required:
              - customer_id
              - tmp_token
              - type
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/update_card:
    post:
      summary: Update a card payment source
      description: "Merchants look to update card details when:\n\n* The billing address\
        \ of a customer has changed. In such a case, modify the billing address in\
        \ the Chargebee and the payment gateway.\n* The expiration date of the card\
        \ has been extended by the bank. (This usually happens when the date of card\
        \ expiry is in near future).\n\nMultiple parameters such as address, expiry\
        \ date, month, and so on, can be updated through this API.\n\nMeta data can\
        \ also be added additionally(supported in Stripe only). Metadata is a JSON\
        \ object. It is used to store additional information about customers.\n\n\
        In **Stripe** and **Braintree** payment gateways, changes in card details\
        \ are auto-updated. This feature can also be used for other payment gateways\
        \ in which auto-update is not enabled or is not supported by Chargebee.  \n\
        **Note**\n: This endpoint supports Chargebee Test Gateway, [Stripe](https://www.chargebee.com/docs/1.0/stripe.html)\n\
        , [Braintree](https://www.chargebee.com/docs/1.0/braintree.html)\n, [Authorize.net](https://www.chargebee.com/docs/1.0/authorize-index.html)\n\
        , [Worldpay US eCom](https://www.chargebee.com/docs/1.0/vantiv_worldpay.html)\n\
        , and [WorldPay Direct Integration](https://www.chargebee.com/docs/1.0/worldpay-direct.html)\n\
        . For all other gateways, your customers must re-enter the full [card details](/docs/api/payment_sources/update-a-card-payment-source#card_first_name)\n\
        to update existing card details. For example, consider a customer not using\
        \ the gateways mentioned above and wants to update the [card\\[billing_addr1\\\
        ]](/docs/api/payment_sources/update-a-card-payment-source#card_billing_addr1)\n\
        parameter. In such a case, the customer must re-enter the value of all the\
        \ parameters present in the [card](/docs/api/payment_sources/update-a-card-payment-source#card_first_name)\n\
        object.\n"
      operationId: update_a_card_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Additional data about this resource can be passed to \*\*Stripe\*\* gateway here in the JSON Format. This will be stored along with payment source at the gateway account.
                  example: null
                reference_transaction:
                  type: string
                  deprecated: false
                  description: |
                    Reference transaction is used for future purchases. This is only applicable for Vantiv.
                  maxLength: 50
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name.
                      maxLength: 50
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/switch_gateway_account:
    post:
      summary: Switch gateway account
      description: "Switches the gateway in which this payment source information\
        \ is stored.\n\nThis is applicable only if the payment source is present in\
        \ Spreedly vault.  \nThis operation does not support switching between Braintree\
        \ and Stripe. If you need help using this API, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).\n"
      operationId: switch_gateway_account
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account you want to switch to.
                  maxLength: 50
                  example: null
              required:
              - gateway_account_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/create_using_token:
    post:
      summary: Create using Chargebee token
      description: |
        Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)
        under Payment source to store the card after successful 3DS flow completion.
      operationId: create_using_chargebee_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |
                    Token generated by Chargebee JS representing payment method details.
                  maxLength: 40
                  example: null
              required:
              - customer_id
              - token_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/delete_local:
    post:
      summary: Local delete a payment source
      description: |
        Deletes a payment method from Chargebee. Payment method in the payment gateway will not be affected.
      operationId: local_delete_a_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/create_bank_account:
    post:
      summary: Create a bank account payment source
      description: |-
        <div class="api-description"><p class="mb-2">This API adds a Direct Debit payment source for a customer. The bank account details collected from your customer are passed as input to this API.</p><h4><a href="https://www.chargebee.com/docs/direct-debit-payments.html#direct-debit-payments-in-the-united-states" target="_blank">Automated Clearing House (ACH) Network</a></h4><p class="mb-2">ACH is an electronic network for passing financial transactions in the US. Chargebee currently supports ACH via <a href="https://www.chargebee.com/docs/ach-payments-stripe.html" target="_blank">Stripe</a> , <a href="https://www.chargebee.com/docs/ach-payments-authorize_net.html" target="_blank">Authorize.Net</a>, and <a href="https://www.chargebee.com/docs/2.0/gocardless.html" target="_blank">GoCardless</a>.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For ACH via Stripe, it is mandatory to pass <a href="/docs/api/advanced-features">user details</a> such as IP address(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-ip</code>) and the device information(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-device</code>).</li>
        </ul></div><h5>Bank account verification</h5><p class="mb-2">Once the bank account has been added, it needs to be verified.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For Stripe, perform this verification using the <a href="/docs/api/payment_sources/verify-bank-account-payment-source">Verify bank account payment source API</a>.</li>
        <li class="text-base leading-relaxed">For <a href="https://www.authorize.net/" target="_blank">Authorize.net</a>, the verification is done by them in 2-3 days after the account is added. No intervention is needed from your side or your customer.</li>
        </ul><h4>Single Euro Payment Area (SEPA)</h4><p class="mb-2">SEPA is an initiative that integrates bank transfer payments denominated in euro. It is supported via <a href="https://www.chargebee.com/docs/gocardless.html" target="_blank">GoCardless</a>, <a href="https://www.chargebee.com/docs/sepa-stripe.html" target="_blank">Stripe</a> and <a href="https://www.chargebee.com/docs/adyen-sepa.html" target="_blank">Adyen</a>.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For SEPA via Stripe, it is mandatory to pass <a href="/docs/api/advanced-features">user details</a> such as IP address and device information.</li>
        <li class="text-base leading-relaxed">For GoCardless, <a href="https://developer.gocardless.com/api-reference/#appendix-local-bank-details" target="_blank">local bank details</a> can be passed instead of IBAN.</li>
        </ul></div><h4>Bacs Payment Schemes Limited (BACS) and Bg Autogiro</h4><p class="mb-2">Bacs is an organization that manages the Direct Debit and Direct Credit payment methods in the UK. Bg Autogiro is a Direct Debit scheme for krona denominated payments in Sweden. Both Bacs and Bg Autogiro are supported via <a href="https://www.chargebee.com/docs/gocardless.html" target="_blank">GoCardless</a>.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For BACS via Stripe, it is mandatory to pass <a href="/docs/api/advanced-features">user details</a> such as IP address(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-ip</code>) and the device information(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-device</code>).</li>
        </ul></div><h4>Bulk Electronic Clearing System (BECS) and Pre-Authorized Debit (PAD)</h4><p class="mb-2">BECS is an automated payment method for Direct Debit in Australia and New Zealand while PAD does the same for Canada. <a href="https://www.chargebee.com/docs/gocardless.html" target="_blank">GoCardless</a> supports both.</p><p class="mb-2">For Direct Debit, the customer needs to accept a mandate that allows the merchant to debit their bank account. This agreement PDF can be obtained using the <a href="/docs/api/hosted_pages/retrieve-direct-debit-agreement-pdf">Retrieve direct debit agreement PDF API</a>.</p><p class="mb-2">If the customer has already reached the payment source limit allowed for the site, pass <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">replace_primary_payment_source</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>. Alternatively, <a href="/docs/api/payment_sources/delete-a-payment-source">delete</a> one of the payment sources first and then add the bank account payment source for the customer.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For BECS via Stripe, it is mandatory to pass <a href="/docs/api/advanced-features">user details</a> such as IP address(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-ip</code>) and the device information(<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-device</code>).</li>
        </ul></div></div>
      operationId: create_a_bank_account_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer with whom this payment source is associated.
                  maxLength: 50
                  example: null
                issuing_country:
                  type: string
                  deprecated: false
                  description: |
                    2-letter(alpha2) ISO country code. Required when local bank details are provided, and not IBAN.
                  maxLength: 50
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                bank_account:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bank_account
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    iban:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's International Bank Account Number. For the [GoCardless](https://www.chargebee.com/docs/gocardless.html)
                        platform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
                      maxLength: 50
                      minLength: 10
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's first name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's last name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's company name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 250
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the account holder that is linked to the bank account.
                      maxLength: 50
                      example: null
                    bank_name:
                      type: string
                      deprecated: false
                      description: |
                        Name of account holder's bank.
                      maxLength: 100
                      example: null
                    account_number:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's bank account number.
                      maxLength: 17
                      minLength: 4
                      example: null
                    routing_number:
                      type: string
                      deprecated: false
                      description: |
                        Bank account routing number.
                      maxLength: 9
                      minLength: 3
                      example: null
                    bank_code:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the bank code.
                      maxLength: 20
                      example: null
                    account_type:
                      type: string
                      deprecated: false
                      description: |
                        Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/)
                        ACH and Razorpay NetBanking users only. If not passed, account type is taken as null.
                        \* current -

                        Current Account
                        \* savings -

                        Savings Account
                        \* checking -

                        Checking Account
                        \* business_checking -

                        Business Checking Account
                      enum:
                      - checking
                      - savings
                      - business_checking
                      - current
                      example: null
                    account_holder_type:
                      type: string
                      deprecated: false
                      description: |
                        For Stripe ACH users only. Indicates the account holder type.
                        \* company -

                        Company Account.
                        \* individual -

                        Individual Account.
                      enum:
                      - individual
                      - company
                      example: null
                    echeck_type:
                      type: string
                      deprecated: false
                      description: |
                        For Authorize.net ACH users only. Indicates the type of eCheck.
                        \* ppd -

                        Payment Authorization is prearranged between the customer and the merchant.
                        \* web -

                        Payment Authorization obtained from the customer via the internet.
                        \* ccd -

                        Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
                      enum:
                      - web
                      - ppd
                      - ccd
                      example: null
                    swedish_identity_number:
                      type: string
                      deprecated: false
                      description: |
                        For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
                      maxLength: 12
                      minLength: 10
                      example: null
                    billing_address:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address associated with the bank account. The value is a JSON object with the following keys and their values:-   <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">company_name</code>:(string, max chars=250) The company name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>:(string) The name of the country for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code>:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li>
                        </ul>
                      example: null
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              bank_account:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /payment_sources/{cust-payment-source-id}/update_bank_account:
    post:
      summary: Update a bank account payment source
      description: |-
        <div class="api-description"><p class="mb-2">This API is used to update the payment source details of a customer. Information related to bank account payment source such as email, first name, and last name can be updated.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">For GoCardless, Chargebee supports (ACH,BACS,SEPA,AUTOGIRO,BECS,BECS_NZ,PAD).</li>
        <li class="text-base leading-relaxed">For Stripe, Chargebee only supports SEPA.</li>
        </ul><div class="alert alert-info"><p class="mb-2">The API is only supported for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method</code> of type <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">direct_debit</code>.</p></div></div>
      operationId: update_a_bank_account_payment_source
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: cust-payment-source-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/cust-payment-source-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                bank_account:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bank_account
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's first name as per bank account.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's last name as per bank account.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Account holder's email address. All Direct Debit compliant emails will be sent to this email address.
                      maxLength: 70
                      example: null
                  example: null
              example: null
            encoding:
              bank_account:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: <p class="mb-2">Resource object representing payment_source</p>
                required:
                - customer
                - payment_source
                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: []
  /virtual_bank_accounts/{virtual-bank-account-id}/delete_local:
    post:
      summary: Local delete a virtual bank account
      description: |
        Deletes virtual bank accounts from Chargebee. Payment method in the payment gateway, and Auto Collection settings in Chargebee are not affected.
      operationId: local_delete_a_virtual_bank_account
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: virtual-bank-account-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/virtual-bank-account-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  virtual_bank_account:
                    $ref: "#/components/schemas/VirtualBankAccount"
                    description: <p class="mb-2">Resource object representing virtual_bank_account</p>
                required:
                - virtual_bank_account
                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: []
  /virtual_bank_accounts/{virtual-bank-account-id}/delete:
    post:
      summary: Delete a virtual bank account
      description: |
        Deletes a virtual bank account. If there is no virtual bank account present in the gateway for the customer, this API will return successfully without throwing an error.
      operationId: delete_a_virtual_bank_account
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: virtual-bank-account-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/virtual-bank-account-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  virtual_bank_account:
                    $ref: "#/components/schemas/VirtualBankAccount"
                    description: <p class="mb-2">Resource object representing virtual_bank_account</p>
                required:
                - virtual_bank_account
                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: []
  /virtual_bank_accounts:
    get:
      summary: List virtual bank accounts
      description: |
        Lists all the virtual bank accounts.
      operationId: list_virtual_bank_accounts
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          Identifier of the customer.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is\] = "3bdjnDnsdQn"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 3bdjnDnsdQn
          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
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this virtual bank account resource was last updated.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this virtual bank account resource is created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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:
                        virtual_bank_account:
                          $ref: "#/components/schemas/VirtualBankAccount"
                          description: Resource object representing virtual_bank_account
                      required:
                      - virtual_bank_account
                      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: []
    post:
      summary: Create a virtual bank account
      description: "Creates a virtual bank account for a customer. Email address is\
        \ mandatory for virtual bank account creation. All notifications related to\
        \ this virtual bank account will be sent to the email address you specify.\
        \  \nCustomer's email and virtual bank accounts will always be in sync.\n"
      operationId: create_a_virtual_bank_account
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    Email address associated with the virtual bank account.
                  maxLength: 70
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Identifier of the gateway account to use when creating the virtual bank account.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Default behavior</strong>
                    When not provided, Chargebee selects an applicable gateway account for the chosen <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>. Selection follows your site&#x27;s <a href="https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Smart Routing</a> rules.</p></div>
                  maxLength: 50
                  example: null
                scheme:
                  type: string
                  default: ach_credit
                  deprecated: false
                  description: |-
                    <p class="mb-2">Type of the credit transfer.</p>
                    * mx_automated_bank_transfer - <p class="mb-2">MX Automated Bank Transfer</p>
                    * sepa_credit - <p class="mb-2">SEPA Credit Transfer</p>
                    <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sepa_credit</code>
                    use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">eu_automated_bank_transfer</code>
                    .</p></div>
                    * eu_automated_bank_transfer - <p class="mb-2">EU Automated Bank Transfer</p>
                    * ach_credit - <p class="mb-2">ACH Credit Transfer</p>
                    <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ach_credit</code>
                    use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">us_automated_bank_transfer</code>
                    .</p></div>
                    * jp_automated_bank_transfer - <p class="mb-2">JP Automated Bank Transfer</p>
                    * us_automated_bank_transfer - <p class="mb-2">US Automated Bank Transfer</p>
                    * gb_automated_bank_transfer - <p class="mb-2">UK Automated Bank Transfer</p>
                  enum:
                  - ach_credit
                  - sepa_credit
                  - us_automated_bank_transfer
                  - gb_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  example: null
              required:
              - customer_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  virtual_bank_account:
                    $ref: "#/components/schemas/VirtualBankAccount"
                    description: <p class="mb-2">Resource object representing virtual_bank_account</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - virtual_bank_account
                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: []
  /virtual_bank_accounts/{virtual-bank-account-id}:
    get:
      summary: Retrieve a virtual bank account
      description: |
        Retrieves the virtual bank account identified by the unique identifier.
      operationId: retrieve_a_virtual_bank_account
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: virtual-bank-account-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/virtual-bank-account-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  virtual_bank_account:
                    $ref: "#/components/schemas/VirtualBankAccount"
                    description: <p class="mb-2">Resource object representing virtual_bank_account</p>
                required:
                - virtual_bank_account
                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: []
  /virtual_bank_accounts/create_using_permanent_token:
    post:
      summary: Create a virtual bank account using permanent token
      description: "Creates a virtual bank account using the identifier provided by\
        \ the gateway.  \nCustomer's email and virtual bank accounts will always be\
        \ in sync. Email ID specified for virtual bank account creation will be considered\
        \ over customers' email ID.\n"
      operationId: create_a_virtual_bank_account_using_permanent_token
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).
                  maxLength: 150
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Identifier of the gateway account to use when creating the virtual bank account.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Default behavior</strong>
                    When not provided, Chargebee selects an applicable gateway account for the chosen <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>. Selection follows your site&#x27;s <a href="https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Smart Routing</a> rules.</p></div>
                  maxLength: 50
                  example: null
                scheme:
                  type: string
                  default: ach_credit
                  deprecated: false
                  description: |-
                    <p class="mb-2">Type of the credit transfer.</p>
                    * mx_automated_bank_transfer - <p class="mb-2">MX Automated Bank Transfer</p>
                    * sepa_credit - <p class="mb-2">SEPA Credit Transfer</p>
                    <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sepa_credit</code>
                    use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">eu_automated_bank_transfer</code>
                    .</p></div>
                    * eu_automated_bank_transfer - <p class="mb-2">EU Automated Bank Transfer</p>
                    * ach_credit - <p class="mb-2">ACH Credit Transfer</p>
                    <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ach_credit</code>
                    use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">us_automated_bank_transfer</code>
                    .</p></div>
                    * jp_automated_bank_transfer - <p class="mb-2">JP Automated Bank Transfer</p>
                    * us_automated_bank_transfer - <p class="mb-2">US Automated Bank Transfer</p>
                    * gb_automated_bank_transfer - <p class="mb-2">UK Automated Bank Transfer</p>
                  enum:
                  - ach_credit
                  - sepa_credit
                  - us_automated_bank_transfer
                  - gb_automated_bank_transfer
                  - eu_automated_bank_transfer
                  - jp_automated_bank_transfer
                  - mx_automated_bank_transfer
                  example: null
              required:
              - customer_id
              - reference_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  virtual_bank_account:
                    $ref: "#/components/schemas/VirtualBankAccount"
                    description: <p class="mb-2">Resource object representing virtual_bank_account</p>
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - virtual_bank_account
                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: []
  /customers/{customer-id}/copy_card:
    post:
      summary: Copy card
      description: "#### deprecated\n\nThe [Payment Sources API](/docs/api/payment_sources)\n\
        , with its additional options and improvements, obsoletes the Cards APIs.\
        \ This request is obsoleted by the [Export payment source API](/docs/api/payment_sources/export-payment-source)\n\
        .\n\nCopies the customer's card information to another payment gateway. This\
        \ is useful if you want to port your customer's card details to another gateway.\
        \  \n**Limitation**\n\nThis request does not support copying of cards between\
        \ Braintree and Stripe payment gateways. Contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)\n\
        to perform those actions.\n"
      operationId: copy_card
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account you want to copy the card.
                  maxLength: 50
                  example: null
              required:
              - gateway_account_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  third_party_payment_method:
                    $ref: "#/components/schemas/ThirdPartyPaymentMethod"
                    description: <p class="mb-2">Resource object representing third_party_payment_method</p>
                required:
                - third_party_payment_method
                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: []
  /cards/{customer-id}:
    get:
      summary: Retrieve card for a customer
      description: |
        #### Deprecated

        This operation is obsoleted by the [Retrieve a payment source API](/docs/api/payment_sources/retrieve-a-payment-source)
        .

        Retrieves the credit card for the customer id.
      operationId: retrieve_card_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - card
                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: []
  /customers/{customer-id}/switch_gateway:
    post:
      summary: Switch gateway
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><h4>Deprecated</h4><p class="mb-2">This request is obsoleted by the <a href="/docs/api/payment_sources/switch-gateway-account">Switch gateway account API</a>
        for Payment Sources.</p></div><p class="mb-2">Switches the gateway in which customer&#x27;s card information is stored. This is applicable only if the payment method is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Limitation</strong></p><p class="mb-2">This request does not support switching between Braintree and Stripe payment gateways. Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
        to perform those actions.</p></div></div>
      operationId: switch_gateway
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account you want to switch to.
                  maxLength: 50
                  example: null
              required:
              - gateway_account_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - card
                - customer
                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: []
  /customers/{customer-id}/delete_card:
    post:
      summary: Delete card for a customer
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><h4>deprecated</h4><p class="mb-2">The <a href="/docs/api/payment_sources">Payment Sources API</a>
        , with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the <a href="/docs/api/payment_sources/delete-a-payment-source">Delete a payment source API</a>
        .</p></div><p class="mb-2">Deletes the card for a customer. Upon successful deletion the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code> attribute for the customer is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">off</code> and a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card_deleted</code> event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.</p></div>
      operationId: delete_card_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                required:
                - customer
                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: []
  /customers/{customer-id}/credit_card:
    post:
      summary: Update card for a customer
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><h4>Deprecated</h4><p class="mb-2">The <a href="/docs/api/payment_sources">Payment Sources API</a>
        , with its additional options and improvements, obsoletes the <a href="/docs/api/cards">Cards APIs</a>
        . This operation is obsoleted by the following:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/payment_sources/create-using-gateway-temporary-token">Create using temporary token</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/payment_sources/create-using-permanent-token">Create using permanent token</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/payment_sources/create-a-card-payment-source">Create a card payment source</a>
        </li>
        </ul></div><p class="mb-2">Adds or replaces card details of a customer. Updating card details replaces the present payment method.</p><p class="mb-2">Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If you are using Stripe gateway, you can use <a href="https://stripe.com/docs/stripe.js" target="_blank">Stripe.js</a> with your card update form.</li>
        <li class="text-base leading-relaxed">If you are using Braintree gateway, you can use <a href="https://www.braintreepayments.com/docs/javascript" target="_blank">Braintree.js</a> with your card update form.</li>
        <li class="text-base leading-relaxed">If you are using Authorize.Net gateway, you use <a href="https://developer.authorize.net/api/reference/features/acceptjs.html" target="_blank">Accept.js</a> with your card update form.</li>
        <li class="text-base leading-relaxed">In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s <a href="https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce" target="_blank">Client Side Encryption</a> to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.</li>
        <li class="text-base leading-relaxed">You can also use our <a href="https://www.chargebee.com/docs/hosted_pages.html" target="_blank">Hosted Pages</a> based integration. Use our <a href="/docs/api/hosted_pages">Hosted Page - Update Card</a> API to generate a &#x27;Update Card&#x27; Hosted Page link.</li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Legacy behavior:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">For <a href="https://www.chargebee.com/docs/sites-intro.html" target="_blank">sites</a> created before March 1st, 2014:</strong> On making this request, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> of the customer are <strong class="font-semibold">deleted</strong> and replaced by the values passed with this request. Ensure that you pass the <a href="/docs/api/v2/pcv-1/subscriptions/create-a-subscription#card_billing_addr1">billing address parameters</a> and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> parameters each time you make this request, to avoid losing the same information at the customer-level.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">For <a href="https://www.chargebee.com/docs/sites-intro.html" target="_blank">sites</a> created on or after March 1st, 2014:</strong> This request does not alter the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> of the customer.</li>
        </ul></div></div>
      operationId: update_card_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account in which this payment source is stored.
                  maxLength: 50
                  example: null
                tmp_token:
                  type: string
                  deprecated: false
                  description: |
                    The single-use card token returned by vaults like Stripe/Braintree which act as a substitute for your card details. Before calling this API, you should have submitted your card details to the gateway and gotten this token in return.
                    **Note:**
                    Supported only for Stripe, Braintree and Authorize.Net. If this value is specified, there is no need to specify other card details (like number, cvv, etc).
                  maxLength: 300
                  example: null
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    Cardholder's first name.
                  maxLength: 50
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    Cardholder's last name.
                  maxLength: 50
                  example: null
                number:
                  type: string
                  deprecated: false
                  description: |
                    The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                    , you can specify the Braintree encrypted card number here.
                  maxLength: 1500
                  example: null
                expiry_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Card expiry month.
                  maximum: 12
                  minimum: 1
                  example: null
                expiry_year:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Card expiry year.
                  example: null
                cvv:
                  type: string
                  deprecated: false
                  description: |
                    The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                    , you can specify the Braintree encrypted CVV here.
                  maxLength: 520
                  example: null
                preferred_scheme:
                  type: string
                  deprecated: false
                  description: "The customer's preferred card scheme for co-branded\
                    \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                    \ for Stripe.\n\\* mada -\n\nA Mada card scheme.\n\\* mastercard\
                    \ -\n\nA MasterCard scheme.\n\\* cartes_bancaires -\n\nA Cartes\
                    \ Bancaires card scheme.\n\\* visa -\n\nA Visa card scheme.\n"
                  enum:
                  - cartes_bancaires
                  - mastercard
                  - visa
                  example: null
                billing_addr1:
                  type: string
                  deprecated: false
                  description: |
                    Address line 1, as available in card billing address.
                  maxLength: 150
                  example: null
                billing_addr2:
                  type: string
                  deprecated: false
                  description: |
                    Address line 2, as available in card billing address.
                  maxLength: 150
                  example: null
                billing_city:
                  type: string
                  deprecated: false
                  description: |
                    City, as available in card billing address.
                  maxLength: 50
                  example: null
                billing_state_code:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                    without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                    ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                    ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                    ).</p>
                  maxLength: 50
                  example: null
                billing_state:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                    is provided.</p>
                  maxLength: 50
                  example: null
                billing_zip:
                  type: string
                  deprecated: false
                  description: |
                    Postal or Zip code, as available in card billing address.
                  maxLength: 20
                  example: null
                billing_country:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                    .</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong>:
                    If you enter an invalid country code, the system will return an error.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                    <p class="mb-2">.</p>
                  maxLength: 50
                  example: null
              required:
              - expiry_month
              - expiry_year
              - number
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  card:
                    $ref: "#/components/schemas/Card"
                    description: <p class="mb-2">Resource object representing card</p>
                required:
                - card
                - customer
                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: []
  /promotional_credits/{account-credit-id}:
    get:
      summary: Retrieve a promotional credit
      description: |
        This endpoint retrieves the promotional credit based on the promotional credit id
      operationId: retrieve_a_promotional_credit
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: account-credit-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/account-credit-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: <p class="mb-2">Resource object representing promotional_credit</p>
                required:
                - promotional_credit
                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: []
  /promotional_credits:
    get:
      summary: List promotional credits
      description: |
        This endpoint lists the promotional credits set for a customer
      operationId: list_promotional_credits
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Unique reference ID provided for promotional credits.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *id\[is\] = "1bkfc8dw2o"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 1bkfc8dw2o
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this promotional credit resource is created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[on\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: type
        in: query
        description: |
          optional, enumerated string filter

          Type of promotional credits. Possible values are : increment, decrement.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *type\[is\] = "increment"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: increment
          properties:
            is:
              type: string
              description: |
                \* \`increment\` - Increment \* \`decrement\` - Decrement
              enum:
              - increment
              - decrement
              example: null
            is_not:
              type: string
              description: |
                \* \`increment\` - Increment \* \`decrement\` - Decrement
              enum:
              - increment
              - decrement
              example: null
            in:
              type: string
              description: |
                \* \`increment\` - Increment \* \`decrement\` - Decrement
              enum:
              - increment
              - decrement
              pattern: "^\\[(increment|decrement)(,(increment|decrement))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`increment\` - Increment \* \`decrement\` - Decrement
              enum:
              - increment
              - decrement
              pattern: "^\\[(increment|decrement)(,(increment|decrement))*\\]$"
              example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          Identifier of the customer.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *customer_id\[is\] = "4gkYnd21ouvW"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 4gkYnd21ouvW
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        promotional_credit:
                          $ref: "#/components/schemas/PromotionalCredit"
                          description: Resource object representing promotional_credit
                      required:
                      - promotional_credit
                      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: []
  /promotional_credits/deduct:
    post:
      summary: Deduct Promotional Credits
      description: |
        This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).

        For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer's credit balance would become $15.

        If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
      operationId: deduct_promotional_credits
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Promotional credits amount.
                  minimum: 0
                  example: null
                amount_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    Amount in decimal.
                  maxLength: 33
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) for promotional credit.
                  maxLength: 3
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Detailed description of this promotional credits.
                  maxLength: 250
                  example: null
                credit_type:
                  type: string
                  default: general
                  deprecated: false
                  description: |
                    Type of promotional credits provided to customer.
                    \* general -

                    General
                    \* referral_rewards -

                    Referral
                    \* loyalty_credits -

                    Loyalty Credits
                  enum:
                  - loyalty_credits
                  - referral_rewards
                  - general
                  example: null
                reference:
                  type: string
                  deprecated: false
                  description: |
                    Describes why promotional credits were provided.
                  maxLength: 500
                  example: null
              required:
              - customer_id
              - description
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: <p class="mb-2">Resource object representing promotional_credit</p>
                required:
                - customer
                - promotional_credit
                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: []
  /promotional_credits/set:
    post:
      summary: Set Promotional Credits
      description: |
        This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).

        For example,

        * If a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
        * If a customer has a credit balance of $10 and if you would like to set the balance to $5, you could pass the **amount** as $5.
        * If a customer has a credit balance of $10 and if you would like to clear the balance, you could pass the **amount** as $0.
      operationId: set_promotional_credits
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Promotional credits amount.
                  minimum: 0
                  example: null
                amount_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    Amount in decimal.
                  maxLength: 33
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) for promotional credit.
                  maxLength: 3
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Detailed description of this promotional credits.
                  maxLength: 250
                  example: null
                credit_type:
                  type: string
                  default: general
                  deprecated: false
                  description: |
                    Type of promotional credits provided to customer. \\\* general - General \\\* referral_rewards - Referral \\\* loyalty_credits - Loyalty Credits
                  enum:
                  - loyalty_credits
                  - referral_rewards
                  - general
                  example: null
                reference:
                  type: string
                  deprecated: false
                  description: |
                    Describes why promotional credits were provided.
                  maxLength: 500
                  example: null
              required:
              - customer_id
              - description
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: <p class="mb-2">Resource object representing promotional_credit</p>
                required:
                - customer
                - promotional_credit
                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: []
  /promotional_credits/add:
    post:
      summary: Add Promotional Credits
      description: |
        This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).

        For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer's credit balance would become $20.
      operationId: add_promotional_credits
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Promotional credits amount.
                  minimum: 0
                  example: null
                amount_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    Amount in decimal.
                  maxLength: 33
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) for promotional credit.
                  maxLength: 3
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Detailed description of this promotional credits.
                  maxLength: 250
                  example: null
                credit_type:
                  type: string
                  default: general
                  deprecated: false
                  description: |
                    Type of promotional credits provided to customer. \\\* general - General \\\* referral_rewards - Referral \\\* loyalty_credits - Loyalty Credits
                  enum:
                  - loyalty_credits
                  - referral_rewards
                  - general
                  example: null
                reference:
                  type: string
                  deprecated: false
                  description: |
                    Describes why promotional credits were provided.
                  maxLength: 500
                  example: null
              required:
              - customer_id
              - description
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: <p class="mb-2">Resource object representing promotional_credit</p>
                required:
                - customer
                - promotional_credit
                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: []
  /invoices/{invoice-id}/delete_line_items:
    post:
      summary: Delete Line Items
      description: |
        This endpoint is used to delete line items from "Pending" invoice.
      operationId: delete_line_items
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                line_items:
                  type: object
                  deprecated: false
                  description: |
                    The list of line items which have to be deleted.
                  properties:
                    id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              line_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/charge_addon:
    post:
      summary: Create invoice for a non-recurring addon
      description: |
        Generate invoices for a non-recurring addon using this API.
      operationId: create_invoice_for_a_non-recurring_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this invoice(not applicable for consolidated invoice) needs to be created. Should be specified if 'customer_id' is not specified.
                  maxLength: 50
                  example: null
                addon_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the non-recurring addon to be charged.
                  maxLength: 100
                  example: null
                addon_quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of addon units to be charged. Mandatory for quantity based addons.
                  minimum: 1
                  example: null
                addon_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                addon_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The number of addon units to be charged in decimal.
                  maxLength: 33
                  example: null
                addon_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    Addon Amount in Decimal.
                  maxLength: 39
                  example: null
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the addon starts.
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the addon ends.
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this invoice.
                  maxLength: 100
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                  enum:
                  - customer
                  - merchant
                  example: null
              required:
              - addon_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/remove_credit_note:
    post:
      summary: Remove credit note from an invoice
      description: |-
        <div class="api-description"><p class="mb-2">This API removes a credit note attached to an invoice. When you remove a credit note from an invoice, the invoice status returns to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        You cannot remove a credit note from an invoice if it has already been refunded.</p></div></div>
      operationId: remove_credit_note_from_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Credit-note id.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                - invoice
                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: []
  /invoices/{invoice-id}/remove_payment:
    post:
      summary: Remove payment from an invoice
      description: "<div class=\"api-description\"><p class=\"mb-2\">This API <a href=\"\
        https://www.chargebee.com/docs/2.0/invoice-operations.html#actions-for-paid-invoices_remove-payment\"\
        \ target=\"_blank\">removes payments</a> applied to an invoice. Once the applied\
        \ payment is removed, the invoice status returns to <code class=\"bg-gray-100\
        \ text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1\
        \ text-sm font-mono whitespace-nowrap\">not_paid</code> or <code class=\"\
        bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5\
        \ py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">payment_due</code>. The\
        \ removed payment is then added to the customer&#x27;s excess payment balance.</p></div>"
      operationId: remove_payment_from_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies the transaction.
                      maxLength: 40
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - invoice
                - transaction
                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: []
  /invoices/{invoice-id}/stop_dunning:
    post:
      summary: Stop dunning for invoice
      description: |
        This API is used to stop dunning for "Payment Due" invoices that have been enabled for Auto Collection. When dunning is stopped, the status of the invoice will be changed to "Not Paid".
      operationId: stop_dunning_for_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/apply_payments:
    post:
      summary: Apply payments for an invoice
      description: "<div class=\"api-description\"><p class=\"mb-2\">The API applies\
        \ <a href=\"/docs/api/customers/customer-object#excess_payments\">excess payments</a>\
        \ to an invoice. Once an excess payment is applied, the <code><a href=\"/docs/api/invoices/invoice-object#amount_due\"\
        >invoice.amount_due</a></code> is recalculated. The invoice <code class=\"\
        bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5\
        \ py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">status</code> changes\
        \ to either <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">paid</code>\
        \ or <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">payment_due</code>\
        \ depending on how much excess payment is applied to the invoice amount.</p><p\
        \ class=\"mb-2\">For example, if you have an excess payment of $25.00, and\
        \ the invoice to which you want to apply this excess payment has a balance\
        \ of $50. Once you apply this excess payment, the invoice status changes to\
        \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">paid</code>,\
        \ and <code><a href=\"/docs/api/invoices/invoice-object#amount_due\">invoice.amount_due</a></code>\
        \ is adjusted to $25.00.</p></div>"
      operationId: apply_payments_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                transactions:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transactions
                  properties:
                    id:
                      type: array
                      description: |
                        Uniquely identifies the transaction. Excess payments available with the customer will be applied against this invoice if this parameter is not passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |-
                        <p class="mb-2">Specifies the amount from the transaction to apply as a payment towards the invoice. The amount applied is the smallest of the following values: the amount you specify for this parameter, <code><a href="/docs/api/invoices/invoice-object#amount_due">transactions.unused_amount</a></code>
                        , or <code><a href="/docs/api/invoices/invoice-object#amount_due">invoice.amount_due</a></code>
                        .</p>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              transactions:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/add_addon_charge:
    post:
      summary: Add non-recurring addon to a pending invoice
      description: |
        Add non-recurring addon to a pending invoice.
      operationId: add_non-recurring_addon_to_a_pending_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                addon_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the non-recurring addon to be charged.
                  maxLength: 100
                  example: null
                addon_quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of addon units to be charged. Mandatory for quantity based addons.
                  minimum: 1
                  example: null
                addon_unit_price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                addon_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).
                    Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                addon_unit_price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    When [price overriding](http://chargebee.com/docs/price-override.html )
                    is enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )
                    can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                    is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this addon needs to be created. Applicable for consolidated invoice.
                  maxLength: 50
                  example: null
                line_item:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_item
                  properties:
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time when the service period for the addon starts.
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time when the service period for the addon ends.
                      example: null
                  example: null
              required:
              - addon_id
              example: null
            encoding:
              line_item:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/void:
    post:
      summary: Void an invoice
      description: |-
        <div class="api-description"><p class="mb-2">Voids the specified invoice. Any payments must be <a href="/docs/api/invoices/remove-payment-from-an-invoice">removed</a> from the invoice before voiding it.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Any <a href="/docs/api/promotional_credits">promotional credits</a> or <a href="/docs/api/credit_notes">credit notes</a> applied to the invoice are removed.</li>
        <li class="text-base leading-relaxed">If an invoice for the current term of a subscription is voided and the subscription is changed later with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">proration</code> enabled, no prorated credits are issued.</li>
        </ul></div>
      operationId: void_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                void_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Invoices \> Void invoice**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/add_charge:
    post:
      summary: Add one-time charge to a pending invoice
      description: <div class="api-description"><p class="mb-2">Adds a one-time charge
        to a <a href="/docs/api/invoices/invoice-object#status" target="_blank">pending</a>
        invoice. A one-time charge is a charge that is added ad hoc to the invoice
        and does not represent a predefined <a href="/docs/api/v2/pcv-1/plans" target="_blank">plan</a>
        or <a href="/docs/api/v2/pcv-1/addons" target="_blank">addon</a>. It appears
        in the invoice as a <code><a href="/docs/api/invoices/invoice-object#line_items"
        target="_blank">line_item</a></code> of <code><a href="/docs/api/invoices/invoice-object#line_items_entity_type"
        target="_blank">entity_type</a></code> <code class="bg-gray-100 text-gray-800
        font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono
        whitespace-nowrap">adhoc</code>.</p></div>
      operationId: add_one-time_charge_to_a_pending_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 1
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Detailed description about this lineitem.
                  maxLength: 250
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* consumed -

                    Transaction is for an item that is consumed directly
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_tax_code:
                  type: string
                  deprecated: false
                  description: |
                    This represents the Avalara tax code to which the one-time charge is mapped. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avatax-for-sales.html)
                    .
                  maxLength: 50
                  example: null
                hsn_code:
                  type: string
                  deprecated: false
                  description: |
                    The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                    to which the one-time charge is mapped for calculating the customer's tax in India. Applicable when both the conditions are true:

                    * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                    * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .
                  maxLength: 50
                  example: null
                taxjar_product_code:
                  type: string
                  deprecated: false
                  description: |
                    This represents the TaxJar product code to which the one-time charge is mapped. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                    .
                  maxLength: 50
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this charge needs to be created. Applicable for consolidated invoice.
                  maxLength: 50
                  example: null
                line_item:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_item
                  properties:
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time when the service period for the charge starts.
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time when the service period for the charge ends.
                      example: null
                  example: null
              required:
              - amount
              - description
              example: null
            encoding:
              line_item:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/send_einvoice:
    post:
      summary: Send an einvoice for invoices
      description: |-
        <div class="api-description"><p class="mb-2">This endpoint is used to send an e-invoice for invoice.
        To support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.
        This endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">If e-invoicing is not enabled at the site and customer level.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If there is an e-invoice generated already for the invoice.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the <strong class="font-semibold">Use automatic e-invoicing</strong>  option is selected.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If there are no generated e-invoices with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skipped</code> status.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the invoice status is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">voided</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>.</p>
        </li>
        </ul></div>
      operationId: send_an_einvoice_for_invoices
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties: {}
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/write_off:
    post:
      summary: Write off an invoice
      description: |
        This API writes off an Invoice.
      operationId: write_off_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                - invoice
                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: []
  /invoices/{invoice-id}/pause_dunning:
    post:
      summary: Pause dunning for invoice
      description: |-
        <div class="api-description"><p class="mb-2">Pause <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">dunning</a> for the specified invoice until <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expected_payment_date</code>. Chargebee cancels all configured payment collection <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">retry attempts</a> and dunning <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html#dunning-email-notifications" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">email notifications</a> for the invoice until <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expected_payment_date</code>.</p><h4>Prerequisites</h4><p class="mb-2">This operation is only permitted for an invoice that meets <em class="italic">all</em> the following conditions:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status" class="text-blue-600 hover:text-blue-800 underline">status</a> of the invoice is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>.</li>
        <li class="text-base leading-relaxed">The invoice belongs to a <a href="/docs/api/v2/pcv-1/subscriptions" class="text-blue-600 hover:text-blue-800 underline">subscription</a> or <a href="/docs/api/v2/pcv-1/customers" class="text-blue-600 hover:text-blue-800 underline">customer</a> with <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#auto_collection" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code></a> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>.</li>
        <li class="text-base leading-relaxed">The invoice does not have dunning paused currently.</li>
        </ul><h4><span id="dunning_resume_process">Automatic dunning resumption</span></h4><p class="mb-2">Unless you <a href="/docs/api/v2/pcv-1/invoices/resume-dunning-for-invoice" class="text-blue-600 hover:text-blue-800 underline">resume dunning</a> for the invoice, Chargebee attempts to collect payment on the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expected_payment_date</code>. If payment collection fails, the next action is taken as follows:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expected_payment_date</code> is within the dunning period for the invoice, Chargebee resumes any dunning retries and email notifications that remain after the pause period, and not attempt the retries or notifications that were canceled during the pause period.</li>
        <li class="text-base leading-relaxed">If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expected_payment_date</code> is after the dunning period for the invoice, the <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">final action</a> configured in Billing is initiated for the invoice and, if applicable, for the subscription.</li>
        </ul></div>
      operationId: pause_dunning_for_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                expected_payment_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date and time at which dunning should resume.
                    **See also** : [Dunning resumption process](/docs/api/v2/pcv-1/invoices/resume-dunning-for-invoice).
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments) to add to the invoice for this operation. This comment is displayed on the Chargebee Billing UI.
                    **Note** : This comment does not appear on any customer-facing [hosted pages](/docs/api/hosted_pages) or documents, such as the [invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf).
                  maxLength: 300
                  example: null
              required:
              - expected_payment_date
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices:
    get:
      summary: List invoices
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Lists all the Invoices.</p></div>
      operationId: list_invoices
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted**
          ' attribute will be '**true**
          '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          The invoice number. Acts as a identifier for invoice and typically generated sequentially.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "INVOICE_654"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: INVOICE_654
          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: subscription_id
        in: query
        description: |
          optional, string filter

          To filter based on subscription_id.
          NOTE: Not to be used if *consolidated invoicing*
          is enabled.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *subscription_id\[is\] = "3bdjnDnsdQn"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 3bdjnDnsdQn
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          The identifier of the customer this invoice belongs to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is_not\] = "3bdjnDnsdQn"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 3bdjnDnsdQn
          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: recurring
        in: query
        description: |
          optional, boolean filter

          Boolean indicating whether this invoice belongs to a subscription. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *recurring\[is\] = "true"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "true"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Current status of this invoice. Possible values are : paid, posted, payment_due, not_paid, voided, pending.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is_not\] = "paid"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: paid
          properties:
            is:
              type: string
              description: |-
                * `paid` - Indicates a paid invoice.
                * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                * `voided` - Indicates a voided invoice.
                * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              example: null
            is_not:
              type: string
              description: |-
                * `paid` - Indicates a paid invoice.
                * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                * `voided` - Indicates a voided invoice.
                * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              example: null
            in:
              type: string
              description: |-
                * `paid` - Indicates a paid invoice.
                * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                * `voided` - Indicates a voided invoice.
                * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `paid` - Indicates a paid invoice.
                * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                * `voided` - Indicates a voided invoice.
                * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                ]$"
              example: null
      - name: price_type
        in: query
        description: |
          optional, enumerated string filter

          The price type of the invoice. Possible values are : tax_exclusive, tax_inclusive.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *price_type\[is\] = "tax_exclusive"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: tax_exclusive
          properties:
            is:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            is_not:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            in:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                ]$"
              example: null
      - name: date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The document date displayed on the invoice PDF.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *date\[after\] = "1394532759"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1394532759"
          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
      - name: paid_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating the date \& time this invoice got paid.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *paid_at\[before\] = "1394532759"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1394532759"
          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
      - name: total
        in: query
        description: |
          optional, in cents filter

          Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *total\[is\] = "1000"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1000"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_paid
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, in cents filter</p></dfn>
          <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
          for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
          that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
          as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.
          <strong class="font-semibold">Supported operators :</strong>
          is, is_not, lt, lte, gt, gte, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">amount_paid[is] = &quot;800&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "800"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_adjusted
        in: query
        description: |
          optional, in cents filter

          Total adjustments made against this invoice.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_adjusted\[is\] = "100"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "100"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: credits_applied
        in: query
        description: |
          optional, in cents filter

          Total credits applied against this invoice.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *credits_applied\[is\] = "100"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "100"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_due
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, in cents filter</p></dfn>
          <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p>
          <ul class="list-disc list-outside ml-6 my-4 space-y-2">
          <li class="text-base leading-relaxed">
          <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code>
          </li>
          <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li>
          <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li>
          <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.
          <strong class="font-semibold">Supported operators :</strong>
          is, is_not, lt, lte, gt, gte, between</li>
          </ul>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">amount_due[is_not] = &quot;200&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: dunning_status
        in: query
        description: |
          optional, enumerated string filter

          Current dunning status of the invoice. Possible values are : in_progress, exhausted, stopped, success.

          **Supported operators :**
          is, is_not, in, not_in, is_present

          **Example →**
          *dunning_status\[is\] = "in_progress"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: in_progress
          properties:
            is:
              type: string
              description: |
                \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
              enum:
              - in_progress
              - exhausted
              - stopped
              - success
              example: null
            is_not:
              type: string
              description: |
                \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
              enum:
              - in_progress
              - exhausted
              - stopped
              - success
              example: null
            in:
              type: string
              description: |
                \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
              enum:
              - in_progress
              - exhausted
              - stopped
              - success
              pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
              enum:
              - in_progress
              - exhausted
              - stopped
              - success
              pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                ]$"
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: payment_owner
        in: query
        description: |
          optional, string filter

          Payment owner of an invoice.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *payment_owner\[is\] = "payment_customer"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: payment_customer
          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
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
          This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
          input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
          for a faster response.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">updated_at[on] = &quot;1243545465&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      - name: voided_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating the date \& time this invoice got voided.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *voided_at\[before\] = "1394532759"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1394532759"
          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
      - name: void_reason_code
        in: query
        description: |
          optional, string filter

          Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Invoices \> Void invoice** .
          Must be passed if set as mandatory in the app. The codes are case-sensitive.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *void_reason_code\[is\] = "Other"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Other
          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: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - date
              - updated_at
              example: null
          example: null
      - name: exclude
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: line_items
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: einvoice
        in: query
        description: |
          Parameters for einvoice
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            status:
              type: object
              deprecated: false
              description: |-
                <p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                , see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code>
                .</p>
              example: failed
              properties:
                is:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  example: null
                is_not:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  example: null
                in:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  pattern: "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\\
                    ]$"
                  example: null
                not_in:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  pattern: "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\\
                    ]$"
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        invoice:
                          $ref: "#/components/schemas/Invoice"
                          description: Resource object representing invoice
                      required:
                      - invoice
                      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: []
    post:
      summary: Create an invoice
      description: "**Note:**\nThis operation optionally supports 3DS verification\
        \ flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\n\
        and pass it as input parameter to this API.\n\nCreates a one-off invoice for\
        \ multiple 'Non Recurring' add-on \\& ad-hoc charges for a customer.\n\nIf\
        \ the 'auto collection' has been turned 'on' for that customer then payment\
        \ will be immediately collected using the payment method associated with the\
        \ customer. The invoice will be generated upon successful collection of payments.\n\
        \nHowever, if the 'auto collection' is turned 'off', no collection attempt\
        \ will be made and the invoice will be generated in the \"Payment Due\" status.\
        \ Customer level auto collection property can be overridden by passing the\
        \ auto_collection parameter.\n\nThe Shipping Address can be passed, which\
        \ will then be attached to the generated invoice.\n\nA 'One Time' coupon can\
        \ be explicitly specified while creating this invoice.\n\nYou can pass the\
        \ authorization_transaction_id to capture the already blocked funds to collect\
        \ the payment. The excess payments will be applied to the invoice followed\
        \ by the captured authorization payment.\n\nIf capturing authorization fails,\
        \ the invoice will not be created. The invoice creation can be retried by\
        \ passing the auto-collection as OFF. If the invoice due amount is greater\
        \ than the authorization \\& excess payment amount collectively, the invoice\
        \ status will be returned as **payment_due**. Collect payment for invoice\
        \ API can be used to collect the remaining amount due.  \n* The authorization\
        \ transaction will not be captured if the fraud status is found as suspicious.\
        \ This api will result in invalid_state_for_request error. Read more on [fraud\
        \ management using Stripe Radar](https://www.chargebee.com/docs/stripe-radar.html).\n\
        * Passing **auto_collection** will not update the customer level property.\n\
        * Available Credits and Excess Payments will automatically be applied to this\
        \ invoice.\n"
      operationId: create_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.(not applicable for consolidated invoice).
                  maxLength: 50
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the invoice amount.
                  maxLength: 3
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
                  example: null
                invoice_note:
                  type: string
                  deprecated: false
                  description: |
                    A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes)
                    for the invoice are displayed on the PDF invoice sent to the customer.
                  maxLength: 2000
                  example: null
                remove_general_note:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    to remove the <a href="https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes" target="_blank"><strong class="font-semibold">general note</strong></a>
                    from this invoice.</p>
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this invoice.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                authorization_transaction_id:
                  type: string
                  deprecated: false
                  description: |
                    Authorization transaction to be captured.
                  maxLength: 40
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    If specified, the customer level auto collection will be overridden.
                    \* on -

                    Whenever an invoice is created, an automatic attempt will be made to charge.
                    \* off -

                    Whenever an invoice is created as payment due.
                  enum:
                  - "on"
                  - "off"
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: |
                    Token generated by Chargebee JS representing payment method details.
                  maxLength: 40
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source should be replaced with this payment source.
                    In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
                  example: null
                retain_payment_source:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Indicates whether the payment source should be retained for the customer.
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for statement_descriptor
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        Payment descriptor text
                      maxLength: 65000
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's first name
                      maxLength: 50
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Cardholder's last name
                      maxLength: 50
                      example: null
                    number:
                      type: string
                      deprecated: false
                      description: |
                        The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted card number here.
                      maxLength: 1500
                      example: null
                    expiry_month:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry month.
                      maximum: 12
                      minimum: 1
                      example: null
                    expiry_year:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Card expiry year.
                      example: null
                    cvv:
                      type: string
                      deprecated: false
                      description: |
                        The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)
                        , you can specify the Braintree encrypted CVV here.
                      maxLength: 520
                      example: null
                    preferred_scheme:
                      type: string
                      deprecated: false
                      description: "The customer's preferred card scheme for co-branded\
                        \ cards.  \n**Note**:\nCurrently, this parameter is only supported\
                        \ for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires\
                        \ card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\
                        \\* visa -\n\nA Visa card scheme.\n\\* mada -\n\nA Mada card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      example: null
                    billing_addr1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_addr2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2, as available in card billing address.
                      maxLength: 150
                      example: null
                    billing_city:
                      type: string
                      deprecated: false
                      description: |
                        City, as available in card billing address.
                      maxLength: 50
                      example: null
                    billing_state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    billing_zip:
                      type: string
                      deprecated: false
                      description: |
                        Postal or Zip code, as available in card billing address.
                      maxLength: 20
                      example: null
                    billing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                bank_account:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bank_account
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    iban:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's International Bank Account Number. For the [GoCardless](https://www.chargebee.com/docs/gocardless.html)
                        platform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
                      maxLength: 50
                      minLength: 10
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's first name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's last name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's company name as per bank account. If not passed, details from customer details will be considered.
                      maxLength: 250
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
                      maxLength: 70
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the account holder that is linked to the bank account.
                      maxLength: 50
                      example: null
                    bank_name:
                      type: string
                      deprecated: false
                      description: |
                        Name of account holder's bank.
                      maxLength: 100
                      example: null
                    account_number:
                      type: string
                      deprecated: false
                      description: |
                        Account holder's bank account number.
                      maxLength: 17
                      minLength: 4
                      example: null
                    routing_number:
                      type: string
                      deprecated: false
                      description: |
                        Bank account routing number.
                      maxLength: 9
                      minLength: 3
                      example: null
                    bank_code:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the bank code.
                      maxLength: 20
                      example: null
                    account_type:
                      type: string
                      deprecated: false
                      description: |
                        Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/)
                        ACH and Razorpay NetBanking users only. If not passed, account type is taken as null.
                        \* checking -

                        Checking Account
                        \* business_checking -

                        Business Checking Account
                        \* savings -

                        Savings Account
                        \* current -

                        Current Account
                      enum:
                      - checking
                      - savings
                      - business_checking
                      - current
                      example: null
                    account_holder_type:
                      type: string
                      deprecated: false
                      description: |
                        For Stripe ACH users only. Indicates the account holder type.
                        \* individual -

                        Individual Account.
                        \* company -

                        Company Account.
                      enum:
                      - individual
                      - company
                      example: null
                    echeck_type:
                      type: string
                      deprecated: false
                      description: |
                        For Authorize.net ACH users only. Indicates the type of eCheck.
                        \* ppd -

                        Payment Authorization is prearranged between the customer and the merchant.
                        \* ccd -

                        Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
                        \* web -

                        Payment Authorization obtained from the customer via the internet.
                      enum:
                      - web
                      - ppd
                      - ccd
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |
                        [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)
                        ISO country code. Required when local bank details are provided, and not IBAN.
                      maxLength: 50
                      example: null
                    swedish_identity_number:
                      type: string
                      deprecated: false
                      description: |
                        For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
                      maxLength: 12
                      minLength: 10
                      example: null
                    billing_address:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address associated with the bank account. The value is a JSON object with the following keys and their values:-   <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">company_name</code>:(string, max chars=250) The company name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>:(string) The name of the country for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code>:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li>
                        </ul>
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_method
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: "The type of payment method. For more details refer\
                        \ [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\n\
                        API under Customer resource.\n\\* grab_pay -\n\nPayments made\
                        \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\\
                        * google_pay -\n\nPayments made via Google Pay.\n\\* after_pay\
                        \ -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made\
                        \ via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\
                        \nPayments made via Sofort.\n\\* twint -\n\nPayments made\
                        \ via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates)\
                        \ Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\
                        \\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay\
                        \ -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                        Represents bank account for which the direct debit or ACH\
                        \ agreement/mandate is created.\n\\* bancontact -\n\nPayments\
                        \ made via Bancontact Card.\n\\* upi -\n\nUPI Payments.\n\\\
                        * revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin\
                        \ -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments\
                        \ made via Alipay.  \nThis payment source is deprecated.\n\
                        \\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments\
                        \ made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\
                        \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                        \ -\n\nPayments made via WeChat Pay.  \nThis payment source\
                        \ is deprecated.\n\\* sepa_instant_transfer -\n\nPayments\
                        \ made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
                        \ made via Dotpay.\n\\* paypal_express_checkout -\n\nPayments\
                        \ made via PayPal Express Checkout.\n\\* ideal -\n\nPayments\
                        \ made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                        \ Payment Standard\n\\* generic -\n\nPayments made via Generic\
                        \ Payment Method.\n\\* klarna_pay_now -\n\nPayments made via\
                        \ Klarna Pay Now\n\\* faster_payments -\n\nPayments made via\
                        \ Faster Payments\n\\* swish -\n\nPayments made via Swish\n\
                        \\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact\
                        \ -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay\
                        \ -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                        \ -\n\nRepresents virtual bank account using which the payment\
                        \ will be done.\n\\* amazon_payments -\n\nPayments made via\
                        \ Amazon Payments.\n\\* card -\n\nCard based payment including\
                        \ credit cards and debit cards. Details about the card can\
                        \ be obtained from the card resource.\n\\* trustly -\n\nTrustly\n\
                        \\* kbc_payment_button -\n\nKBC Payment Button\n\\* cash_app_pay\
                        \ -\n\nPayments made via Cash App Pay.\n"
                      enum:
                      - card
                      - paypal_express_checkout
                      - amazon_payments
                      - direct_debit
                      - generic
                      - alipay
                      - unionpay
                      - apple_pay
                      - wechat_pay
                      - ideal
                      - google_pay
                      - sofort
                      - bancontact
                      - giropay
                      - dotpay
                      - upi
                      - netbanking_emandates
                      - venmo
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - automated_bank_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .
                        For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**
                        This is not the one-time temporary token provided by gateways like Stripe.

                        For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)
                        API under Customer resource.
                      maxLength: 200
                      example: null
                    tmp_token:
                      type: string
                      deprecated: false
                      description: |
                        Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
                      maxLength: 65000
                      example: null
                    issuing_country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ) is available as an option.</p>
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* dotpay -

                        dotpay
                        \* faster_payments - \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* payme -

                        Payments made via PayMe
                        \* google_pay -

                        google_pay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* ideal -

                        ideal
                        \* boleto -

                        boleto
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* after_pay -

                        Payments made via Afterpay
                        \* grab_pay -

                        Payments made via GrabPay
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer - \* bancontact -

                        bancontact
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* swish -

                        Payments made via Swish
                        \* go_pay -

                        Payments made via GoPay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* venmo - \* alipay -

                        Payments made via Alipay.
                        \* pay_to - \* pay_co -

                        Payments made via PayCo
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* pay_by_bank -

                        Pay By Bank
                        \* apple_pay -

                        apple_pay
                        \* giropay -

                        giropay
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        amazon_payments
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).
                        Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )
                        can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the addon starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the addon ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                        Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    taxable:
                      type: array
                      description: |
                        The amount to be charged is taxable or not.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    tax_profile_id:
                      type: array
                      description: |
                        Tax profile of the charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_tax_code:
                      type: array
                      description: |
                        The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    hsn_code:
                      type: array
                      description: |
                        The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                        to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                        * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                        * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    taxjar_product_code:
                      type: array
                      description: |
                        The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                          \* retail -

                          Transaction is a sale to an end user
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the charge starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the charge ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
                notes_to_remove:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for notes_to_remove
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Type of entity to which the <a href="/docs/api/invoices/invoice-object#notes">note</a>
                          belongs. To remove the general note, use the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remove_general_note</code>
                          parameter.</p>
                          * charge_item_price - <p class="mb-2">Indicates that this line item is based on charge Item Price</p>
                          * plan_item_price - <p class="mb-2">Indicates that this line item is based on plan Item Price</p>
                          * coupon - <p class="mb-2">Entity that represents a coupon.</p>
                          * addon - <p class="mb-2">Entity that represents an addon.</p>
                          * addon_item_price - <p class="mb-2">Indicates that this line item is based on addon Item Price</p>
                          * plan - <p class="mb-2">Entity that represents a plan.</p>
                          * customer - <p class="mb-2">Entity that represents a customer.</p>
                          * subscription - <p class="mb-2">Entity that represents a subscription of customer.</p>
                        enum:
                        - plan
                        - addon
                        - customer
                        - subscription
                        - coupon
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              bank_account:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              notes_to_remove:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_method:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/close:
    post:
      summary: Close a pending invoice
      description: |-
        <div class="api-description"><p class="mb-2">Finalizes a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> invoice. Invoices are created with a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when <a href="https://www.chargebee.com/docs/metered_billing.html" target="_blank">Metered Billing</a> is enabled. Ensure that usage charges are added before invoking this API as an invoice without any <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items</code> cannot be closed. Any <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refundable_credits</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">excess_payments</code> for the customer are applied to the invoice, and any payment due is collected automatically if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code> for the customer.</p><h4>Related Tutorial</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <a href="https://www.chargebee.com/tutorials/usage-based-billing-example.html" target="_blank">Check out the tutorial on how to use metered / usage based billing.</a>
        </li>
        </ul></div>
      operationId: close_a_pending_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                invoice_note:
                  type: string
                  deprecated: false
                  description: |
                    A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes)
                    for the invoice are displayed on the PDF invoice sent to the customer.
                  maxLength: 2000
                  example: null
                remove_general_note:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    to remove the <a href="https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes" target="_blank"><strong class="font-semibold">general note</strong></a>
                    from this invoice.</p>
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Set the [invoice date](/docs/api/invoices/invoice-object#date).
                    Must lie between the date when the invoice was generated and current date. Can only be passed when the site setting to allow overriding is enabled. If not passed, then the default value [set at the site level](https://www.chargebee.com/docs/metered_billing.html#overview)
                    is used.
                  example: null
                notes_to_remove:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for notes_to_remove
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Type of entity to which the <a href="/docs/api/invoices/invoice-object#notes">note</a>
                          belongs. To remove the general note, use the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remove_general_note</code>
                          parameter.</p>
                          * customer - <p class="mb-2">Entity that represents a customer.</p>
                          * plan - <p class="mb-2">Entity that represents a plan.</p>
                          * charge_item_price - <p class="mb-2">Indicates that this line item is based on charge Item Price</p>
                          * coupon - <p class="mb-2">Entity that represents a coupon.</p>
                          * addon - <p class="mb-2">Entity that represents an addon.</p>
                          * addon_item_price - <p class="mb-2">Indicates that this line item is based on addon Item Price</p>
                          * subscription - <p class="mb-2">Entity that represents a subscription of customer.</p>
                          * plan_item_price - <p class="mb-2">Indicates that this line item is based on plan Item Price</p>
                        enum:
                        - plan
                        - addon
                        - customer
                        - subscription
                        - coupon
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              notes_to_remove:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/apply_credits:
    post:
      summary: Apply credits for an invoice
      description: "<div class=\"api-description\"><p class=\"mb-2\">This API applies\
        \ <a href=\"/docs/api/customers/customer-object#balances\">available credits</a>\
        \ to an invoice. After credits are applied, <code><a href=\"/docs/api/invoices/invoice-object#amount_due\"\
        >invoice.amount_due</a></code> is recalculated. The invoice status changes\
        \ to either <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">paid</code>\
        \ or <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">payment_due</code>\
        \ depending on how much credit is applied to the invoice amount.</p></div>"
      operationId: apply_credits_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                credit_notes:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_notes
                  properties:
                    id:
                      type: array
                      description: |
                        The Credit Note number acts as an identifier for Credit Notes and is typically generated sequentially. Available refundable credits with the customer will be applied against this invoice if this paramenter is not passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              credit_notes:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}:
    get:
      summary: Retrieve an invoice
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Retrieve the invoice for the specified invoice ID.</p></div>
      operationId: retrieve_an_invoice
      parameters:
      - name: line_items_limit
        in: query
        description: "Specify the maximum number of line items to include in the response.\
          \  \n**Note:**\n\n* Applicable only when Enterprise-scale Invoicing is enabled.\n\
          * Enterprise-scale Invoicing is currently in **Private Beta** . Please reach\
          \ out to [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)\
          \ to enable this feature.\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          deprecated: false
          maximum: 300
          minimum: 1
          example: null
      - name: line_items_offset
        in: query
        description: |-
          <p class="mb-2">Specify the starting point for retrieving line items. Use the value from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items_next_offset</code> attribute of the previous retrieve API response.</p>
          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
          <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li>
          <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this feature.</li>
          </ul></div>
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 1000
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/charge:
    post:
      summary: Create invoice for a one-time charge
      description: |
        Generate invoices for a one-time charge using this API.
      operationId: create_invoice_for_a_one-time_charge
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.(not applicable for consolidated invoice).
                  maxLength: 50
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the invoice amount. Applicable only while creating an invoice for a customer (by specifying *customer_id*
                    ).
                  maxLength: 3
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 1
                  example: null
                amount_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                    Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description for this charge.
                  maxLength: 250
                  example: null
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the charge starts.
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time when the service period for the charge ends.
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                    \* consumed -

                    Transaction is for an item that is consumed directly
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this invoice.
                  maxLength: 100
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                  enum:
                  - customer
                  - merchant
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              required:
              - description
              example: null
            encoding:
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/update_details:
    post:
      summary: Update invoice details
      description: "This API allows you to update the invoice Billing/Shipping address,\
        \ VAT, custom fields, and PO number. During this operation if Billing Info\
        \ (Billing Address, vat_number), Shipping info and PO number are not already\
        \ present in the system the data will be added. If data is already present,\
        \ the existing values will be replaced. If info is present in the system,\
        \ but not passed as part of the request, the info will not be removed from\
        \ the system.  \n**Note:**\nIncase, tax is already applied will now vary due\
        \ to address change, you cannot update the address. You cannot update the\
        \ VAT Number if the billing address is not present in the API request.This\
        \ will update the invoice only, it won't change the corresponding customer/subscription\
        \ details.\n"
      operationId: update_invoice_details
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                vat_number:
                  type: string
                  deprecated: false
                  description: |
                    VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)
                    .
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                    Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ).</p>
                    <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                    in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                    the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                    That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                    The first two characters of the VAT number in such a case is
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                    Set
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                    to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                    for such cases.</p>
                  maxLength: 10
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this invoice.
                  maxLength: 100
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* invalid -

                        Address is invalid.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                statement_descriptor:
                  type: object
                  deprecated: false
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      maxLength: 65000
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/record_payment:
    post:
      summary: Record an invoice payment
      description: |
        To record a [offline payment](https://www.chargebee.com/docs/offline_payments.html) for an invoice.

        The invoice status will be marked as 'paid' if its amount due becomes 0 because of this recorded payment.

        **Note:** If the payment transaction amount is more than the invoice due amount, the remaining transaction amount will be added to the customer's Excess Payments balance to be used against other invoices.
      operationId: record_an_invoice_payment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the payment.
                  maxLength: 300
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The payment transaction amount. If not specified, this value will be the invoice's due amount.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction</p>
                        * cash - <p class="mb-2">Cash</p>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * online_banking_poland - <p class="mb-2">Online Banking Poland</p>
                        <span featureId="cb-online-banking-poland" isMicro="true"></span>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * custom - <p class="mb-2">Custom</p>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * upi - <p class="mb-2">upi</p>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * trustly - <p class="mb-2">Trustly</p>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        The reference number for this transaction. e.g check number in case of 'check' payments.
                      maxLength: 100
                      example: null
                    custom_payment_method_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the custom payment method of this transaction.
                      maxLength: 50
                      example: null
                    id_at_gateway:
                      type: string
                      deprecated: false
                      description: |
                        The id with which this transaction is referred in gateway.
                      maxLength: 100
                      example: null
                    status:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The status of this transaction.</p>
                        * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                        * success - <p class="mb-2">The transaction is successful.</p>
                        * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                        or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                        * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                        * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                        * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                        * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                        status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                        You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                        (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                        transaction to be reconciled at par with the gateway.</p>
                        <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                        about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                        transaction status</p></div>
                      enum:
                      - success
                      - failure
                      - late_failure
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates when this transaction occurred.
                      example: null
                    error_code:
                      type: string
                      deprecated: false
                      description: |
                        Error code received from the payment gateway on failure.
                      maxLength: 100
                      example: null
                    error_text:
                      type: string
                      deprecated: false
                      description: |
                        Error message received from the payment gateway on failure.
                      maxLength: 65000
                      example: null
                  required:
                  - payment_method
                  example: null
              example: null
            encoding:
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - invoice
                - transaction
                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: []
  /invoices/{invoice-id}/delete:
    post:
      summary: Delete an invoice
      description: |-
        <div class="api-description"><p class="mb-2">Deletes the specified invoice. Any payments must be <a href="/docs/api/invoices/remove-payment-from-an-invoice">removed</a> from the invoice before deleting it.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Any <a href="/docs/api/promotional_credits">promotional credits</a> or <a href="/docs/api/credit_notes">credit notes</a> applied to the invoice are removed.</li>
        <li class="text-base leading-relaxed">If an invoice for the current term of a subscription is deleted and the subscription is changed later with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">proration</code> enabled, no prorated credits are issued.</li>
        </ul></div>
      operationId: delete_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting the invoice. This comment will be added to the subscription entity if the invoice belongs to a subscription. It is added to the customer entity if the invoice is associated only with a customer.
                  maxLength: 300
                  example: null
                claim_credits:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether to put prorated credits back to the subscription or ignore while deleting the invoice.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/import_invoice:
    post:
      summary: Import invoice
      description: "Imports an invoice into Chargebee Billing. This endpoint allows\
        \ you to import an invoice from external systems, such as accounting software,\
        \ into Chargebee.  \n**Caution: Importing Current-Term Invoices**\nTo ensure\
        \ accurate [proration](https://www.chargebee.com/docs/1.0/proration.html#introduction_proration)\
        \ for any changes to the subscription in the current term, only import one\
        \ current term invoice. Chargebee considers only the first imported invoice\
        \ for the current term when calculating proration. If there are multiple invoices\
        \ for the current term in the source system, consolidate them into a single\
        \ invoice before importing it into Chargebee.\n"
      operationId: import_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Invoice Number.
                  maxLength: 50
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) for the invoice.
                  maxLength: 3
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for which this invoice needs to be created.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    If recurring items are present in line items then subscription id is required.
                  maxLength: 50
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this invoice.
                  maxLength: 100
                  example: null
                price_type:
                  type: string
                  default: tax_exclusive
                  deprecated: false
                  description: |
                    The price type of the invoice.
                    \* tax_inclusive -

                    All amounts in the document are inclusive of tax.
                    \* tax_exclusive -

                    All amounts in the document are exclusive of tax.
                  enum:
                  - tax_exclusive
                  - tax_inclusive
                  example: null
                tax_override_reason:
                  type: string
                  deprecated: false
                  description: |
                    The reason for exempting the invoice from tax. (Applicable only for exempted invoices.).
                    \* export -

                    The customer is from a non-taxable region or the billing address and shipping address are unavailable.
                    \* customer_exempt -

                    The customer is [exempted](/docs/api/customers/customer-object#taxability)
                    from tax.
                    \* id_exempt -

                    The customer is from a different country than your business and they have a valid VAT number or, the customer is a business entity. (This reason is only applicable when [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                    or [UK VAT](https://www.chargebee.com/docs/uk-vat.html)
                    is enabled.)
                  enum:
                  - id_exempt
                  - customer_exempt
                  - export
                  example: null
                vat_number:
                  type: string
                  deprecated: false
                  description: |
                    Vat Number. Required if this invoice is VAT exempted.
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                    Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ).</p>
                    <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                    in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                    the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                    That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                    The first two characters of the VAT number in such a case is
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                    Set
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                    to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                    for such cases.</p>
                  maxLength: 10
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Date when invoice raised.
                  example: null
                total:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Invoice total amount.
                  minimum: 0
                  example: null
                round_off:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Round off amount.
                  maximum: 99
                  minimum: -99
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Current status of this invoice.</p>
                    * not_paid - <p class="mb-2">Indicates the payment is not made and all attempts to collect is failed.</p>
                    * voided - <p class="mb-2">Indicates a voided invoice.</p>
                    * paid - <p class="mb-2">Indicates a paid invoice.</p>
                    * posted - <p class="mb-2">Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period</p>
                    * pending - <p class="mb-2">The <a href="/docs/api/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when it has line items that belong to items that are <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> or when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.create_pending_invoices</code>attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site.</p>
                    * payment_due - <p class="mb-2">Indicates the payment is not yet collected and is being retried as per retry settings.</p>
                  enum:
                  - paid
                  - posted
                  - payment_due
                  - not_paid
                  - voided
                  - pending
                  example: null
                voided_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Timestamp indicating the date \& time this invoice got voided.
                  example: null
                void_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Invoices \> Void invoice**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                is_written_off:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If is_written_off is true then the invoice is written off.
                  example: null
                write_off_amount:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |
                    Amount written off against this invoice.
                    If this value is not present then the due amount of the invoice will be written off.
                  minimum: 0
                  example: null
                write_off_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date on which the write_off invoice has occurred.
                    This is a mandatory field if is_written_off is true. The same date reflects on the created credit note.
                  example: null
                due_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Invoice Due Date.
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    Invoice net term days.
                  example: null
                has_advance_charges:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Boolean indicating any advance charge is present in this invoice.
                  example: null
                use_for_proration:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If the invoice falls within the subscription current term will be used for proration.
                  example: null
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique identifier for the credit note.

                        This is a mandatory field if is_written_off is true.
                      maxLength: 50
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_items
                  properties:
                    id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        Start date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        End date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: |
                        A unique identifier for the subscription this line item belongs to.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this line item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        Unit amount of the line item.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2"><a href="/docs/api/invoices/invoice-object#line_items_quantity">Quantity of the recurring item</a> which is represented by this line item. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> line items, this value is updated from <a href="/docs/api/usages">usages</a> once when the invoice is generated as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> and finally when the invoice is <a href="/docs/api/invoices/close-a-pending-invoice">closed</a>.
                        <a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity">Quantity of the recurring item</a> which is represented by this line item.</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Total amount of this lineitem. Not required if the line_items\[unit_amount\] param is passed
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                        x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                        Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies the modelled entity this line item is based on.
                          \* addon -

                          Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                          id
                          \* plan -

                          Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                          \* plan_item_price -

                          Indicates that this line item is based on plan Item Price
                          \* addon_item_price -

                          Indicates that this line item is based on addon Item Price
                          \* charge_item_price -

                          Indicates that this line item is based on charge Item Price
                          \* adhoc -

                          Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                          \* plan_setup -

                          Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                        enum:
                        - plan_setup
                        - plan
                        - addon
                        - adhoc
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount1_entity_id:
                      type: array
                      description: |
                        First item level discount entity id
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount1_amount:
                      type: array
                      description: |
                        First item level discount amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_level_discount2_entity_id:
                      type: array
                      description: |
                        Second item level discount entity id
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount2_amount:
                      type: array
                      description: |
                        Second item level discount amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax1_name:
                      type: array
                      description: |
                        First tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax1_amount:
                      type: array
                      description: |
                        First tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax2_name:
                      type: array
                      description: |
                        Second tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax2_amount:
                      type: array
                      description: |
                        Second tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax3_name:
                      type: array
                      description: |
                        Third tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax3_amount:
                      type: array
                      description: |
                        Third tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax4_name:
                      type: array
                      description: |
                        Fourth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax4_amount:
                      type: array
                      description: |
                        Fourth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax5_name:
                      type: array
                      description: |
                        Fifth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax5_amount:
                      type: array
                      description: |
                        Fifth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax6_name:
                      type: array
                      description: |
                        Sixth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax6_amount:
                      type: array
                      description: |
                        Sixth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax7_name:
                      type: array
                      description: |
                        Seventh tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax7_amount:
                      type: array
                      description: |
                        Seventh tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax8_name:
                      type: array
                      description: |
                        Eighth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax8_amount:
                      type: array
                      description: |
                        Eighth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax9_name:
                      type: array
                      description: |
                        Ninth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax9_amount:
                      type: array
                      description: |
                        Ninth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax10_name:
                      type: array
                      description: |
                        Tenth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax10_amount:
                      type: array
                      description: |
                        Tenth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    created_at:
                      type: array
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - description
                  example: null
                payment_reference_numbers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_reference_numbers
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is not provided then our system will automatically generate a unique id.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">This attribute helps <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
                          field in the API, specifies how to reconcile offline payments, and generate <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
                          on invoices based on country-specific rules. Setting the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
                          field generates <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
                          for the respective country and includes them on the invoice for correct reconciliation.</p>
                          * swiss_reference - <p class="mb-2">Switzerland based number calculated using MOD 10 and Mod 95 algorithm based on reference type.</p>
                          * kid - <p class="mb-2">The KID number (kundeidentifikasjon) in Norway is an abbreviation for &quot;Customer identification&quot;. It is used to associate payments with the customer and invoice.</p>
                          * fik - <p class="mb-2">Denmark based number calculated using recursive MOD 10 algorithm.</p>
                          * frn - <p class="mb-2">The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.</p>
                          * ocr - <p class="mb-2">A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.</p>
                        enum:
                        - kid
                        - ocr
                        - frn
                        - fik
                        - swiss_reference
                        example: null
                      example: null
                    number:
                      type: array
                      description: |-
                        <p class="mb-2">If you have already generated a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
                        in another system, you can provide it in this field. This number will then be made available to you both in PDF format and via the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">/api/v2/invoices/payment_reference_numbers</code>
                        API.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - number
                  - type
                  example: null
                line_item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_item_tiers
                  properties:
                    line_item_id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    quantity_used:
                      type: array
                      description: |
                        The number of units purchased in a range.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                  required:
                  - line_item_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    line_item_id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                          * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                          in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                          .</p>
                          * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                          * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                          applied to the invoice.</p>
                          * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        - promotional_credits
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |-
                        <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                        , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the coupon. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this deduction.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  required:
                  - amount
                  - entity_type
                  example: null
                taxes:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for taxes
                  properties:
                    name:
                      type: array
                      description: |
                        The name of the tax applied
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    rate:
                      type: array
                      description: |
                        The rate of tax used to calculate tax amount
                      items:
                        type: number
                        format: double
                        default: 0
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Total tax amount charged for this invoice
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description of tax
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    juris_type:
                      type: array
                      items:
                        type: string
                        default: other
                        deprecated: false
                        description: |
                          The type of tax jurisdiction
                          \* country -

                          The tax jurisdiction is a country
                          \* special -

                          Special tax jurisdiction.
                          \* state -

                          The tax jurisdiction is a state
                          \* city -

                          The tax jurisdiction is a city
                          \* other -

                          Jurisdictions other than the ones listed above.
                          \* unincorporated -

                          Combined tax of state and county.
                          \* federal -

                          The tax jurisdiction is a federal
                          \* county -

                          The tax jurisdiction is a county
                        enum:
                        - country
                        - federal
                        - state
                        - county
                        - city
                        - special
                        - unincorporated
                        - other
                        example: null
                      example: null
                    juris_name:
                      type: array
                      description: |
                        The name of the tax jurisdiction
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    juris_code:
                      type: array
                      description: |
                        The tax jurisdiction code
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                  required:
                  - name
                  - rate
                  example: null
                payments:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payments
                  properties:
                    id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Payment made for this invoice
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    payment_method:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Mode of payment</p>
                          * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                          * faster_payments - <p class="mb-2">Faster Payments</p>
                          <span featureId="cb-faster-payments" isMicro="true"></span>
                          * sepa_credit - <p class="mb-2">SEPA Credit</p>
                          * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                          * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                          = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                          This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                          occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                          .</p>
                          * google_pay - <p class="mb-2">Google Pay</p>
                          * check - <p class="mb-2">Check</p>
                          * giropay - <p class="mb-2">giropay</p>
                          * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                          <span featureId="cb-wechat-pay" isMicro="true"></span>
                          * go_pay - <p class="mb-2">Payments made via GoPay</p>
                          <span featureId="cb-go-pay" isMicro="true"></span>
                          * pay_to - <p class="mb-2">PayTo</p>
                          <span featureId="cb-pay-to" isMicro="true"></span>
                          * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                          <span featureId="cb-grab-pay" isMicro="true"></span>
                          * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                          <span featureId="cb-naver-pay" isMicro="true"></span>
                          * pay_co - <p class="mb-2">Payments made via PayCo</p>
                          <span featureId="cb-pay-co" isMicro="true"></span>
                          * alipay - <p class="mb-2">Payments made via Alipay.</p>
                          <span featureId="cb-alipay" isMicro="true"></span>
                          * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                          * payme - <p class="mb-2">Payments made via PayMe</p>
                          <span featureId="cb-payme" isMicro="true"></span>
                          * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                          <span featureId="cb-cash-app-pay" isMicro="true"></span>
                          * swish - <p class="mb-2">Payments made via Swish</p>
                          <span featureId="cb-swish" isMicro="true"></span>
                          * sofort - <p class="mb-2">Sofort</p>
                          * dotpay - <p class="mb-2">Dotpay</p>
                          * bank_transfer - <p class="mb-2">Bank Transfer</p>
                          * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                          <span featureId="cb-revolut-pay" isMicro="true"></span>
                          * venmo - <p class="mb-2">Venmo</p>
                          <span featureId="cb-venmo" isMicro="true"></span>
                          * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                          <span featureId="cb-kakao-pay" isMicro="true"></span>
                          * ach_credit - <p class="mb-2">ACH Credit</p>
                          * ideal - <p class="mb-2">IDEAL</p>
                          * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                          <span featureId="cb-after-pay" isMicro="true"></span>
                          * trustly - <p class="mb-2">Trustly</p>
                          * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                          <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                          * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                          <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                          * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                          <span featureId="cb-stablecoin" isMicro="true"></span>
                          * custom - <p class="mb-2">Custom</p>
                          * upi - <p class="mb-2">upi</p>
                          * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                          <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                          * boleto - <p class="mb-2">boleto</p>
                          * apple_pay - <p class="mb-2">Apple Pay</p>
                          * amazon_payments - <p class="mb-2">Amazon Payments</p>
                          * direct_debit - <p class="mb-2">Direct Debit</p>
                          * bancontact - <p class="mb-2">Bancontact</p>
                          * twint - <p class="mb-2">Payments made via Twint</p>
                          <span featureId="cb-twint" isMicro="true"></span>
                          * pix - <p class="mb-2">Pix</p>
                          <span featureId="cb-pix" isMicro="true"></span>
                          * other - <p class="mb-2">Payment Methods other than the above types</p>
                          * cash - <p class="mb-2">Cash</p>
                          * unionpay - <p class="mb-2">Unionpay</p>
                          * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                          <span featureId="cb-bank-transfer" isMicro="true"></span>
                          * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                          * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                          * card - <p class="mb-2">Card</p>
                        enum:
                        - cash
                        - check
                        - bank_transfer
                        - other
                        - custom
                        example: null
                      example: null
                    date:
                      type: array
                      description: |
                        Payment date
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    reference_number:
                      type: array
                      description: |
                        Reference number for this payment
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        minLength: 1
                        example: null
                      example: null
                  required:
                  - amount
                  - payment_method
                  example: null
                notes:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for notes
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Type of entity to which the note belongs.
                          \* subscription -

                          Entity that represents a subscription of customer.
                          \* plan_item_price -

                          Indicates that this line item is based on plan Item Price
                          \* customer -

                          Entity that represents a customer.
                          \* plan -

                          Entity that represents a plan.
                          \* coupon -

                          Entity that represents a coupon.
                          \* tax -

                          The note is configured as part of the [tax configuration](https://www.chargebee.com/docs/tax.html)
                          in Chargebee Billing.
                          \* addon_item_price -

                          Indicates that this line item is based on addon Item Price
                          \* charge_item_price -

                          Indicates that this line item is based on charge Item Price
                          \* addon -

                          Entity that represents an addon.
                        enum:
                        - plan
                        - addon
                        - coupon
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        Id of the mentioned entity type
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    note:
                      type: array
                      description: |
                        Actual note.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 65000
                        example: null
                      example: null
                  example: null
                line_item_addresses:
                  type: object
                  deprecated: false
                  description: |
                    The list of addresses used for tax calculation on line items.
                  properties:
                    line_item_id:
                      type: array
                      description: |
                        Line item reference
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    first_name:
                      type: array
                      description: |
                        First name of the customer
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    last_name:
                      type: array
                      description: |
                        Last name of the customer
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    email:
                      type: array
                      description: |
                        Email address of the customer
                      items:
                        type: string
                        format: email
                        deprecated: false
                        maxLength: 70
                        example: null
                      example: null
                    company:
                      type: array
                      description: |
                        Name of the company
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    phone:
                      type: array
                      description: |
                        Phone number of the customer
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    line1:
                      type: array
                      description: |
                        Address line 1
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    line2:
                      type: array
                      description: |
                        Address line 2
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    line3:
                      type: array
                      description: |
                        Address line 3
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    city:
                      type: array
                      description: |
                        Name of the city
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state_code:
                      type: array
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state:
                      type: array
                      description: |
                        State or Province
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    zip:
                      type: array
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 20
                        example: null
                      example: null
                    country:
                      type: array
                      description: "The billing address of the customer, specified\
                        \ as an [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                        Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ is enabled, 'United Kingdom-Northern Ireland' is a valid\
                        \ option.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    validation_status:
                      type: array
                      items:
                        type: string
                        default: not_validated
                        deprecated: false
                        description: |
                          The address verification status.
                          \* invalid -

                          Address is invalid.
                          \* not_validated -

                          Address is not yet validated.
                          \* partially_valid -

                          The address is valid for taxability but has not been validated for shipping.
                          \* valid -

                          Address was validated successfully.
                        enum:
                        - not_validated
                        - valid
                        - partially_valid
                        - invalid
                        example: null
                      example: null
                  example: null
              required:
              - date
              - id
              - total
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              credit_note:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              line_item_addresses:
                style: deepObject
                explode: true
              line_item_tiers:
                style: deepObject
                explode: true
              line_items:
                style: deepObject
                explode: true
              notes:
                style: deepObject
                explode: true
              payment_reference_numbers:
                style: deepObject
                explode: true
              payments:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              taxes:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/resume_dunning:
    post:
      summary: Resume dunning for invoice
      description: |-
        <div class="api-description"><p class="mb-2">Immediately resumes <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">dunning</a> for the specified invoice.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If the current time is within the dunning period for the invoice, Chargebee resumes any dunning <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">retries</a> and <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html#dunning-email-notifications" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">email notifications</a> that remain after the pause period, and not attempt the retries or notifications that were canceled during the pause period.</li>
        <li class="text-base leading-relaxed">If the current time is after the dunning period for the invoice, the <a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">final action</a> configured in Billing is initiated for the invoice and, if applicable, for the subscription.</li>
        </ul><h4>Prerequisites</h4><p class="mb-2">This operation is only permitted for an invoice with a <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status" class="text-blue-600 hover:text-blue-800 underline">status</a> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> and for which dunning was previously <a href="/docs/api/v2/pcv-1/invoices/pause-dunning-for-invoice" class="text-blue-600 hover:text-blue-800 underline">paused</a>.</p></div>
      operationId: resume_dunning_for_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/record_tax_withheld:
    post:
      summary: Record tax withheld for an invoice
      description: |-
        <div class="api-description"><span featureId="cb-tax-withheld"></span><p class="mb-2">Records <code><a href="/docs/api/tax_withheld">tax_withheld</a></code> by the customer against the invoice specified. This operation is allowed only when all of the following conditions are true:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Tax Amount Withheld is enabled.</li>
        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code> does not have a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_taxes_withheld</code> record associated with it already.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.amount_due</code> is greater than zero.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.status</code> is one of the following: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">posted</code>.</li>
        </ul></div>
      operationId: record_tax_withheld_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                tax_withheld:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_withheld
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The amount withheld by the customer as tax from the invoice. This must not exceed <code><a href="/docs/api/invoices/invoice-object#amount_due">invoice.amount_due</a></code>.
                        The unit depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <span featureId="cb-tax-withheld" isMicro="true"></span>
                      minimum: 1
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
                      maxLength: 100
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Date or time associated with this tax amount withheld. The default value is the time of invoking this operation.
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        The description for this tax withheld.
                      maxLength: 65000
                      example: null
                  required:
                  - amount
                  example: null
              example: null
            encoding:
              tax_withheld:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/resend_einvoice:
    post:
      summary: Resend failed einvoice in invoices
      description: |
        Resend failed einvoice of an invoice to the customer using this API.
      operationId: resend_failed_einvoice_in_invoices
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties: {}
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/remove_tax_withheld:
    post:
      summary: Remove tax withheld for an invoice
      description: |-
        <div class="api-description"><span featureId="cb-tax-withheld"></span><p class="mb-2">Removes a <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a></code> record from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code> specified. This operation is allowed only when all of the following conditions are true:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code><a href="/docs/api/invoices/invoice-object#status">invoice.status</a></code> is one of the following: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">posted</code>.</li>
        <li class="text-base leading-relaxed">There are no <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code> associated with the invoice.</li>
        <li class="text-base leading-relaxed">There are no <code><a href="/docs/api/invoices/invoice-object#issued_credit_notes">issued_credit_notes</a></code> associated with the invoice.</li>
        </ul></div>
      operationId: remove_tax_withheld_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                tax_withheld:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_withheld
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_</code>.
                        For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_16BdDXSlbu4uV1Ee6</code>
                        .</p>
                      maxLength: 40
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              tax_withheld:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/payment_reference_numbers:
    get:
      summary: List payment reference numbers
      description: |-
        <div class="api-description"><p class="mb-2">This API endpoint allows users to retrieve the payment reference numbers (PRNs) associated with an invoice. Only one PRN is allowed per payment type. You can use the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_id</code>
        or the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number[number]</code>
        to retrieve the PRN.</p></div>
      operationId: list_payment_reference_numbers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          An unique identifier for the invoice serves that links the invoice to the corresponding payment reference number (PRN).
          **Note** :
          To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "old_inv_001"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: old_inv_001
          properties:
            is:
              type: string
              minLength: 1
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: payment_reference_number
        in: query
        description: |
          Parameters for payment_reference_number
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            number:
              type: object
              deprecated: false
              description: |
                This parameter is used to identify the PRN in the system and retrieve its corresponding payment information. \*\*Note\*\*: To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API.
              example: "001234"
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                in:
                  type: string
                  pattern: "^\\[(.*)(,.*)*\\]$"
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        payment_reference_number:
                          $ref: "#/components/schemas/PaymentReferenceNumber"
                          description: Resource object representing payment_reference_number
                      required:
                      - payment_reference_number
                      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: []
  /invoices/{invoice-id}/collect_payment:
    post:
      summary: Collect payment for an invoice
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Storing card after successful 3DS completion is not supported in this API. Use <a href="/docs/api/payment_sources/create-using-payment-intent">create using Payment Intent API</a> under Payment source to store the card after successful 3DS flow completion.</li>
        <li class="text-base leading-relaxed">This endpoint returns an error if a payment is initiated for an invoice with a <a href="/docs/api/invoices/invoice-object#status">status</a> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">app_store</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">play_store</code> <a href="/docs/api/invoices/invoice-object#channel">channels</a>.</li>
        </ul></div><p class="mb-2">This API is used to collect payments for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid invoices</code>. If no payment methods are present for the customer or if the payment is unsuccessful, the corresponding error will be thrown.
        Pass <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">authorization_transaction_id</code> to capture the already blocked funds to collect payments. Note that if the invoice due amount is greater than the authorized amount, the invoice status is returned as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>.</p><div class="alert alert-info"><p class="mb-2">The authorization transaction will not be captured if the fraud status is found as suspicious. This api will result in invalid_state_for_request error. Read more on <a href="https://www.chargebee.com/docs/stripe-radar.html" target="_blank">fraud management using Stripe Radar</a>
        .</p></div></div>
      operationId: collect_payment_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount to be collected. If this parameter is not passed then the entire amount due will be collected.
                  minimum: 1
                  example: null
                authorization_transaction_id:
                  type: string
                  deprecated: false
                  description: |
                    Authorization transaction to be captured.
                  maxLength: 40
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)
                    .
                  maxLength: 300
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The type of initiator to be used for the payment request triggered by this operation.
                    \* merchant -

                    Pass this value to indicate that the request is initiated by the merchant
                    \* customer -

                    Pass this value to indicate that the request is initiated by the customer
                  enum:
                  - customer
                  - merchant
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - invoice
                - transaction
                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: []
  /invoices/{invoice-id}/sync_usages:
    post:
      summary: Sync usages
      description: |-
        <div class="api-description"><p class="mb-2">Updates the <a href="/docs/api/invoices/invoice-object#line_items_quantity" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code></a> for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> <a href="/docs/api/invoices/invoice-object#line_items" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items</code></a> of an invoice to reflect the latest <a href="/docs/api/usages">usage</a> data.
        <strong class="font-semibold">Note:</strong> This operation is done automatically while <a href="/docs/api/invoices/close-a-pending-invoice">closing</a> the invoice.</p></div>
      operationId: sync_usages
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/refund:
    post:
      summary: Refund an invoice
      description: |-
        <div class="api-description"><p class="mb-2">Refunds the invoice. The <a href="https://www.chargebee.com/docs/refunds.html" target="_blank">refund</a> request is processed via the payment gateway originally used to charge the customer. You can choose to either make a full refund for the entire amount or make many partial refunds until you reach the total amount charged for the invoice. The API returns an error if an attempt is made to:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Refund an offline invoice. For such invoices, use the <a href="/docs/api/v2/pcv-1/invoices/record-refund-for-an-invoice">Record refund API</a>.</li>
        <li class="text-base leading-relaxed">Refund a fully refunded invoice.</li>
        </ul><p class="mb-2">If the refund transaction succeeds, a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code> capturing this refund detail is created for the invoice.</p></div>
      operationId: refund_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                refund_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount to be refunded. If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid via online <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction</code>
                    s, and not already refunded.</p>
                    <p class="mb-2"><strong class="font-semibold">Note:</strong>
                    Any <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a></code>
                    associated with the invoice cannot be refunded via this operation.</p>
                  minimum: 1
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Comment, if any, on the refund.
                  maxLength: 300
                  example: null
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    The Customer Notes to be filled in the Credit Notes created to capture this refund detail.
                  maxLength: 2000
                  example: null
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    reason_code:
                      type: string
                      deprecated: false
                      description: |
                        The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
                        parameter instead\]
                        \* product_unsatisfactory -

                        Product Unsatisfactory
                        \* chargeback -

                        Can be set when you are recording your customer Chargebacks
                        \* service_unsatisfactory -

                        Service Unsatisfactory
                        \* write_off -

                        This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                        operation.
                        \* subscription_change -

                        This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                        is enabled
                        \* fraudulent -

                        FRAUDULENT
                        \* other -

                        Can be set when none of the above reason codes are applicable
                        \* subscription_pause -

                        This reason will be automatically set to credit notes created during pause/resume subscription operation.
                        \* waiver -

                        Waiver
                        \* order_cancellation -

                        Order Cancellation
                        \* order_change -

                        Order Change
                        \* subscription_cancellation -

                        This reason will be set automatically for Credit Notes created during cancel subscription operation
                      enum:
                      - product_unsatisfactory
                      - service_unsatisfactory
                      - order_change
                      - order_cancellation
                      - waiver
                      - other
                      example: null
                    create_reason_code:
                      type: string
                      deprecated: false
                      description: |
                        Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note. The codes are case-sensitive
                      maxLength: 100
                      example: null
                  example: null
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - invoice
                - transaction
                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: []
  /invoices/{invoice-id}/record_refund:
    post:
      summary: Record refund for an invoice
      description: |-
        <div class="api-description"><p class="mb-2">Refunds the invoice. The refund is provided against the following in order of precedence:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Offline <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments</a></code></li>
        <li class="text-base leading-relaxed">Any <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a></code></li>
        <li class="text-base leading-relaxed">Online <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments</a></code></li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong></p><p class="mb-2">Consider an invoice with the following payments and tax withheld.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Offline payments: $30</li>
        <li class="text-base leading-relaxed">Online payments: $20</li>
        <li class="text-base leading-relaxed">Tax withheld: $5</li>
        </ul><p class="mb-2">When recording a refund worth $40, the refund amount is split as follows:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Refund against offline payments: $30</li>
        <li class="text-base leading-relaxed">Refund against tax withheld: $5</li>
        <li class="text-base leading-relaxed">Refund against online payments: $5</li>
        </ul></div><p class="mb-2">For payments made via online transactions, the <a href="https://www.chargebee.com/docs/refunds.html" target="_blank">refund</a> request is processed via the payment gateway originally used to charge the customer.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</strong></p><p class="mb-2">If the order of precendence described above does not work for your use case, and you want to provide a refund against online <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments</code> first, use the <a href="/docs/api/invoices/refund-an-invoice">Refund an invoice API</a>.</p></div></div>
      operationId: record_refund_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the refund.
                  maxLength: 65000
                  example: null
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    The Customer Notes to be filled in the Credit Notes created to capture this refund detail.
                  maxLength: 2000
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid (and not already refunded) for the invoice.</p>
                        <p class="mb-2"><strong class="font-semibold">Note:</strong>
                        Any <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a></code>
                        associated with the invoice can also be recorded as refunded via this operation.</p>
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction</p>
                        * cash - <p class="mb-2">Cash</p>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * custom - <p class="mb-2">Custom</p>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * upi - <p class="mb-2">upi</p>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * trustly - <p class="mb-2">Trustly</p>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - chargeback
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                        .</p>
                      maxLength: 100
                      example: null
                    custom_payment_method_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the custom payment method of this transaction.
                      maxLength: 50
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates when this transaction occurred.
                      example: null
                  required:
                  - date
                  - payment_method
                  example: null
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    reason_code:
                      type: string
                      deprecated: false
                      description: |
                        The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
                        parameter instead\]
                        \* service_unsatisfactory -

                        Service Unsatisfactory
                        \* subscription_pause -

                        This reason will be automatically set to credit notes created during pause/resume subscription operation.
                        \* order_cancellation -

                        Order Cancellation
                        \* subscription_cancellation -

                        This reason will be set automatically for Credit Notes created during cancel subscription operation
                        \* product_unsatisfactory -

                        Product Unsatisfactory
                        \* subscription_change -

                        This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                        is enabled
                        \* other -

                        Can be set when none of the above reason codes are applicable
                        \* order_change -

                        Order Change
                        \* chargeback -

                        Can be set when you are recording your customer Chargebacks
                        \* write_off -

                        This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                        operation.
                        \* fraudulent -

                        FRAUDULENT
                        \* waiver -

                        Waiver
                      enum:
                      - chargeback
                      - product_unsatisfactory
                      - service_unsatisfactory
                      - order_change
                      - order_cancellation
                      - waiver
                      - other
                      example: null
                    create_reason_code:
                      type: string
                      deprecated: false
                      description: |
                        Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note. The codes are case-sensitive
                      maxLength: 100
                      example: null
                  example: null
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - invoice
                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: []
  /invoices/{invoice-id}/pdf:
    post:
      summary: Retrieve Invoice as PDF
      description: |
        Gets the invoice as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.

        #### Related Tutorial

        * [Check out customer portal tutorial on how to download invoice as PDF.](https://www.chargebee.com/tutorials/customer-portal-sample.html#downloading_invoices_as_pdf)
      operationId: retrieve_invoice_as_pdf
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                disposition_type:
                  type: string
                  default: attachment
                  deprecated: false
                  description: |
                    Determines the pdf should be rendered as inline or attachment in the browser.
                    \* attachment -

                    PDF is rendered as attachment in the browser
                    \* inline -

                    PDF is rendered as inline in the browser
                  enum:
                  - attachment
                  - inline
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  download:
                    $ref: "#/components/schemas/Download"
                    description: <p class="mb-2">Resource object representing download</p>
                required:
                - download
                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: []
  /invoices/{invoice-id}/download_einvoice:
    get:
      summary: Download e-invoice
      description: |-
        <div class="api-description"><span featureId="cb-einvoicing"></span><p class="mb-2">Download the e-invoice in both XML and PDF formats. The response consists of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">download</code> object for each format. The XML format follows the <a href="https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/tree/" target="_blank" rel="noopener noreferrer">structure as per Peppol BIS Billing v3.0</a>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">You can only download e-invoices when their <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</li>
        <li class="text-base leading-relaxed">There are some cases in which the PDF is not available for download. In such cases, you can obtain it from the XML by decoding the value for <code><a href="https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AdditionalDocumentReference/cac-Attachment/cbc-EmbeddedDocumentBinaryObject/" target="_blank" rel="noopener noreferrer">cbc:EmbeddedDocumentBinaryObject</a></code>, which is the Base64-encoded version of the PDF.</li>
        </ul></div></div>
      operationId: download_e-invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloads:
                    type: array
                    description: <p class="mb-2">Resource object representing download</p>
                    items:
                      $ref: "#/components/schemas/Download"
                      description: Resource object representing download
                    example: null
                required:
                - downloads
                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: []
  /credit_notes/{credit-note-id}/record_refund:
    post:
      summary: Record refund for a credit note
      description: "<div class=\"api-description\"><p class=\"mb-2\">Refunds a (<a\
        \ href=\"https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note\"\
        \ target=\"_blank\">refundable</a>) credit note. The refund is provided against\
        \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">linked_payments</code>\
        \ first and then against any <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >linked_taxes_withheld</code> for the <code><a href=\"/docs/api/credit_notes/credit_note-object#reference_invoice_id\"\
        >invoice</a></code> associated with the <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">credit_note</code>. For payments made via online transactions,\
        \ the refund request is processed via the <a href=\"/docs/api/payment_sources\"\
        >payment source</a> associated with the <a href=\"/docs/api/transactions\"\
        >transaction</a>.</p></div>"
      operationId: record_refund_for_a_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                refund_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for the refund. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Refund Credit Note**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the refund.
                  maxLength: 300
                  example: null
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    id:
                      type: string
                      deprecated: false
                      maxLength: 40
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire <a href="/docs/api/credit_notes/credit_note-object#amount_available">refundable amount</a>
                        for this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
                        is refunded.</p>
                        <p class="mb-2">Note: Any <code><a href="/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds">linked_tax_withheld_refunds</a></code>
                        associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
                        can also be recorded as refunded via this operation.</p>
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The payment method of this transaction</p>
                        * cash - <p class="mb-2">Cash</p>
                        * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                        <span featureId="cb-grab-pay" isMicro="true"></span>
                        * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                        <span featureId="cb-kakao-pay" isMicro="true"></span>
                        * swish - <p class="mb-2">Payments made via Swish</p>
                        <span featureId="cb-swish" isMicro="true"></span>
                        * alipay - <p class="mb-2">Payments made via Alipay.</p>
                        <span featureId="cb-alipay" isMicro="true"></span>
                        * sofort - <p class="mb-2">Sofort</p>
                        * direct_debit - <p class="mb-2">Direct Debit</p>
                        * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                        * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                        * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                        <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                        * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                        <span featureId="cb-naver-pay" isMicro="true"></span>
                        * twint - <p class="mb-2">Payments made via Twint</p>
                        <span featureId="cb-twint" isMicro="true"></span>
                        * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                        <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                        * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                        * go_pay - <p class="mb-2">Payments made via GoPay</p>
                        <span featureId="cb-go-pay" isMicro="true"></span>
                        * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                        * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                        * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                        <span featureId="cb-bank-transfer" isMicro="true"></span>
                        * venmo - <p class="mb-2">Venmo</p>
                        <span featureId="cb-venmo" isMicro="true"></span>
                        * bancontact - <p class="mb-2">Bancontact</p>
                        * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                        <span featureId="cb-after-pay" isMicro="true"></span>
                        * custom - <p class="mb-2">Custom</p>
                        * ideal - <p class="mb-2">IDEAL</p>
                        * check - <p class="mb-2">Check</p>
                        * upi - <p class="mb-2">upi</p>
                        * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                        <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                        * sepa_credit - <p class="mb-2">SEPA Credit</p>
                        * ach_credit - <p class="mb-2">ACH Credit</p>
                        * faster_payments - <p class="mb-2">Faster Payments</p>
                        <span featureId="cb-faster-payments" isMicro="true"></span>
                        * trustly - <p class="mb-2">Trustly</p>
                        * bank_transfer - <p class="mb-2">Bank Transfer</p>
                        * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                        This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                        occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                        .</p>
                        * unionpay - <p class="mb-2">Unionpay</p>
                        * apple_pay - <p class="mb-2">Apple Pay</p>
                        * dotpay - <p class="mb-2">Dotpay</p>
                        * amazon_payments - <p class="mb-2">Amazon Payments</p>
                        * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                        <span featureId="cb-wechat-pay" isMicro="true"></span>
                        * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                        <span featureId="cb-cash-app-pay" isMicro="true"></span>
                        * google_pay - <p class="mb-2">Google Pay</p>
                        * payme - <p class="mb-2">Payments made via PayMe</p>
                        <span featureId="cb-payme" isMicro="true"></span>
                        * pay_co - <p class="mb-2">Payments made via PayCo</p>
                        <span featureId="cb-pay-co" isMicro="true"></span>
                        * card - <p class="mb-2">Card</p>
                        * other - <p class="mb-2">Payment Methods other than the above types</p>
                        * boleto - <p class="mb-2">boleto</p>
                        * giropay - <p class="mb-2">giropay</p>
                        * pay_to - <p class="mb-2">PayTo</p>
                        <span featureId="cb-pay-to" isMicro="true"></span>
                        * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                        <span featureId="cb-stablecoin" isMicro="true"></span>
                        * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                        <span featureId="cb-revolut-pay" isMicro="true"></span>
                        * pix - <p class="mb-2">Pix</p>
                        <span featureId="cb-pix" isMicro="true"></span>
                      enum:
                      - cash
                      - check
                      - chargeback
                      - bank_transfer
                      - other
                      - custom
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                        .</p>
                      maxLength: 100
                      example: null
                    custom_payment_method_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the custom payment method of this transaction.
                      maxLength: 50
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates when this transaction occurred.
                      example: null
                  required:
                  - date
                  - payment_method
                  example: null
              example: null
            encoding:
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - credit_note
                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: []
  /credit_notes/import_credit_note:
    post:
      summary: Import credit note
      description: |
        Use this api to import credit notes into your Chargebee site. Billing address, Shipping Address, Vat number will be copied from the reference invoice.
      operationId: import_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Credit Note Number.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    This identifies the customer for whom the credit note needs to be created.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the subscription for which this credit note needs to be created.
                  maxLength: 50
                  example: null
                reference_invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the invoice against which this Credit Note is issued.
                  maxLength: 50
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)
                    about credit note types.
                    \* refundable -

                    Refundable Credit Note
                    \* store -

                    Store Credit Note
                    \* adjustment -

                    Adjustment Credit Note
                  enum:
                  - adjustment
                  - refundable
                  - store
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) for the credit note.
                  maxLength: 3
                  example: null
                create_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date the Credit Note is issued.
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The credit note status.
                    \* refund_due -

                    When the credits are yet to be used, or have been partially used.
                    \* refunded -

                    When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                    \* voided -

                    When the Credit Note has been cancelled.
                    \* adjusted -

                    When the Credit Note has been adjusted against an invoice.
                  enum:
                  - adjusted
                  - refunded
                  - refund_due
                  - voided
                  example: null
                total:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |
                    Credit Note amount in cents.
                  minimum: 0
                  example: null
                refunded_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time this Credit Note gets fully used. Please note that this field is not present when partial refunds are issued.
                  example: null
                voided_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Timestamp indicating the date and time this Credit Note gets voided.
                  example: null
                sub_total:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The Credit Note sub-total.
                  minimum: 0
                  example: null
                round_off_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
                    If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
                    , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                    .</p>
                  maximum: 99
                  minimum: -99
                  example: null
                fractional_correction:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Indicates the fractional correction amount.
                  maximum: 50000
                  minimum: -50000
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                    Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                    ).</p>
                    <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                    in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                    the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                    <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                    That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                    The first two characters of the VAT number in such a case is
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                    by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                    Set
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                    to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                    for such cases.</p>
                  maxLength: 10
                  example: null
                line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_items
                  properties:
                    reference_line_item_id:
                      type: array
                      description: |
                        Uniquely identifies a line_item of invoice for which this reversal represents.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        Start date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        End date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: |
                        A unique identifier for the subscription this line item belongs to.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this line item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        Unit amount of the line item.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2"><a href="/docs/api/invoices/invoice-object#line_items_quantity">Quantity of the recurring item</a> which is represented by this line item. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> line items, this value is updated from <a href="/docs/api/usages">usages</a> once when the invoice is generated as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> and finally when the invoice is <a href="/docs/api/invoices/close-a-pending-invoice">closed</a>.
                        <a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity">Quantity of the recurring item</a> which is represented by this line item.</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Total amount of this lineitem. Not required if the line_items\[unit_amount\] param is passed
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                        x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                        Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies the modelled entity this line item is based on.
                          \* addon -

                          Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                          id
                          \* plan_item_price -

                          Indicates that this line item is based on plan Item Price
                          \* addon_item_price -

                          Indicates that this line item is based on addon Item Price
                          \* charge_item_price -

                          Indicates that this line item is based on charge Item Price
                          \* adhoc -

                          Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                          \* plan_setup -

                          Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                          \* plan -

                          Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                          id
                        enum:
                        - plan_setup
                        - plan
                        - addon
                        - adhoc
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount1_entity_id:
                      type: array
                      description: |
                        First item level discount entity id
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount1_amount:
                      type: array
                      description: |
                        First item level discount amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_level_discount2_entity_id:
                      type: array
                      description: |
                        Second item level discount entity id
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_level_discount2_amount:
                      type: array
                      description: |
                        Second item level discount amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax1_name:
                      type: array
                      description: |
                        First tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax1_amount:
                      type: array
                      description: |
                        First tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax2_name:
                      type: array
                      description: |
                        Second tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax2_amount:
                      type: array
                      description: |
                        Second tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax3_name:
                      type: array
                      description: |
                        Third tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax3_amount:
                      type: array
                      description: |
                        Third tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax4_name:
                      type: array
                      description: |
                        Fourth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax4_amount:
                      type: array
                      description: |
                        Fourth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax5_name:
                      type: array
                      description: |
                        Fifth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax5_amount:
                      type: array
                      description: |
                        Fifth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax6_name:
                      type: array
                      description: |
                        Sixth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax6_amount:
                      type: array
                      description: |
                        Sixth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax7_name:
                      type: array
                      description: |
                        Seventh tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax7_amount:
                      type: array
                      description: |
                        Seventh tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax8_name:
                      type: array
                      description: |
                        Eighth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax8_amount:
                      type: array
                      description: |
                        Eighth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax9_name:
                      type: array
                      description: |
                        Ninth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax9_amount:
                      type: array
                      description: |
                        Ninth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax10_name:
                      type: array
                      description: |
                        Tenth tax name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax10_amount:
                      type: array
                      description: |
                        Tenth tax amount
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  required:
                  - description
                  example: null
                line_item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_item_tiers
                  properties:
                    line_item_id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    quantity_used:
                      type: array
                      description: |
                        The number of units purchased in a range.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                  required:
                  - line_item_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    line_item_id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                          * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                          in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                          .</p>
                          * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                          .</p>
                          * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                          * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                          applied to the invoice.</p>
                          * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                          applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                          The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                          is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                          <span featureId="cb-discounts" isMicro="true"></span>
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        - promotional_credits
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |-
                        <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                        , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the coupon. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this deduction.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  required:
                  - amount
                  - entity_type
                  example: null
                taxes:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for taxes
                  properties:
                    name:
                      type: array
                      description: |
                        The name of the tax applied
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    rate:
                      type: array
                      description: |
                        The rate of tax used to calculate tax amount
                      items:
                        type: number
                        format: double
                        default: 0
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Total tax amount charged for this invoice
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description of tax
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    juris_type:
                      type: array
                      items:
                        type: string
                        default: other
                        deprecated: false
                        description: |
                          The type of tax jurisdiction
                          \* country -

                          The tax jurisdiction is a country
                          \* special -

                          Special tax jurisdiction.
                          \* county -

                          The tax jurisdiction is a county
                          \* state -

                          The tax jurisdiction is a state
                          \* city -

                          The tax jurisdiction is a city
                          \* other -

                          Jurisdictions other than the ones listed above.
                          \* unincorporated -

                          Combined tax of state and county.
                          \* federal -

                          The tax jurisdiction is a federal
                        enum:
                        - country
                        - federal
                        - state
                        - county
                        - city
                        - special
                        - unincorporated
                        - other
                        example: null
                      example: null
                    juris_name:
                      type: array
                      description: |
                        The name of the tax jurisdiction
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    juris_code:
                      type: array
                      description: |
                        The tax jurisdiction code
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                  required:
                  - name
                  - rate
                  example: null
                allocations:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for allocations
                  properties:
                    invoice_id:
                      type: array
                      description: |
                        The unique invoice ID for the allocation
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    allocated_amount:
                      type: array
                      description: |
                        The allocated amount for the credit note
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    allocated_at:
                      type: array
                      description: |
                        Time when the allocation was occurred
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - allocated_amount
                  - allocated_at
                  - invoice_id
                  example: null
                linked_refunds:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for linked_refunds
                  properties:
                    id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Amount of this refund transaction.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    payment_method:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Mode of refund.</p>
                          * twint - <p class="mb-2">Payments made via Twint</p>
                          <span featureId="cb-twint" isMicro="true"></span>
                          * amazon_payments - <p class="mb-2">Amazon Payments</p>
                          * payme - <p class="mb-2">Payments made via PayMe</p>
                          <span featureId="cb-payme" isMicro="true"></span>
                          * sepa_credit - <p class="mb-2">SEPA Credit</p>
                          * sofort - <p class="mb-2">Sofort</p>
                          * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                          * alipay - <p class="mb-2">Payments made via Alipay.</p>
                          <span featureId="cb-alipay" isMicro="true"></span>
                          * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                          <span featureId="cb-bank-transfer" isMicro="true"></span>
                          * direct_debit - <p class="mb-2">Direct Debit</p>
                          * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                          * trustly - <p class="mb-2">Trustly</p>
                          * pay_co - <p class="mb-2">Payments made via PayCo</p>
                          <span featureId="cb-pay-co" isMicro="true"></span>
                          * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                          <span featureId="cb-kakao-pay" isMicro="true"></span>
                          * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                          <span featureId="cb-naver-pay" isMicro="true"></span>
                          * giropay - <p class="mb-2">giropay</p>
                          * dotpay - <p class="mb-2">Dotpay</p>
                          * bancontact - <p class="mb-2">Bancontact</p>
                          * go_pay - <p class="mb-2">Payments made via GoPay</p>
                          <span featureId="cb-go-pay" isMicro="true"></span>
                          * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                          <span featureId="cb-grab-pay" isMicro="true"></span>
                          * other - <p class="mb-2">Payment Methods other than the above types</p>
                          * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                          <span featureId="cb-revolut-pay" isMicro="true"></span>
                          * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                          <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                          * swish - <p class="mb-2">Payments made via Swish</p>
                          <span featureId="cb-swish" isMicro="true"></span>
                          * upi - <p class="mb-2">upi</p>
                          * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                          <span featureId="cb-wechat-pay" isMicro="true"></span>
                          * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                          * venmo - <p class="mb-2">Venmo</p>
                          <span featureId="cb-venmo" isMicro="true"></span>
                          * faster_payments - <p class="mb-2">Faster Payments</p>
                          <span featureId="cb-faster-payments" isMicro="true"></span>
                          * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                          <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                          * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                          * unionpay - <p class="mb-2">Unionpay</p>
                          * ideal - <p class="mb-2">IDEAL</p>
                          * cash - <p class="mb-2">Cash</p>
                          * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                          <span featureId="cb-stablecoin" isMicro="true"></span>
                          * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                          = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                          This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                          occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                          .</p>
                          * boleto - <p class="mb-2">boleto</p>
                          * custom - <p class="mb-2">Custom</p>
                          * google_pay - <p class="mb-2">Google Pay</p>
                          * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                          * pay_to - <p class="mb-2">PayTo</p>
                          <span featureId="cb-pay-to" isMicro="true"></span>
                          * card - <p class="mb-2">Card</p>
                          * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                          <span featureId="cb-cash-app-pay" isMicro="true"></span>
                          * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                          <span featureId="cb-after-pay" isMicro="true"></span>
                          * bank_transfer - <p class="mb-2">Bank Transfer</p>
                          * apple_pay - <p class="mb-2">Apple Pay</p>
                          * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                          <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                          * check - <p class="mb-2">Check</p>
                          * pix - <p class="mb-2">Pix</p>
                          <span featureId="cb-pix" isMicro="true"></span>
                          * ach_credit - <p class="mb-2">ACH Credit</p>
                        enum:
                        - cash
                        - check
                        - bank_transfer
                        - other
                        - custom
                        example: null
                      example: null
                    date:
                      type: array
                      description: |
                        The date of refund.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    reference_number:
                      type: array
                      description: |
                        Reference number for this refund.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        minLength: 1
                        example: null
                      example: null
                  required:
                  - amount
                  - date
                  - payment_method
                  example: null
              required:
              - create_reason_code
              - date
              - id
              - reference_invoice_id
              - type
              example: null
            encoding:
              allocations:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              line_item_tiers:
                style: deepObject
                explode: true
              line_items:
                style: deepObject
                explode: true
              linked_refunds:
                style: deepObject
                explode: true
              taxes:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/delete:
    post:
      summary: Delete a credit Note
      description: |
        This API [deletes a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If you try to delete a refunded or deleted credit note, an error message will be displayed.
      operationId: delete_a_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/pdf:
    post:
      summary: Retrieve credit note as PDF
      description: |
        Gets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.
      operationId: retrieve_credit_note_as_pdf
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                disposition_type:
                  type: string
                  default: attachment
                  deprecated: false
                  description: |
                    Determines the pdf should be rendered as inline or attachment in the browser.
                    \* attachment -

                    PDF is rendered as attachment in the browser
                    \* inline -

                    PDF is rendered as inline in the browser
                  enum:
                  - attachment
                  - inline
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  download:
                    $ref: "#/components/schemas/Download"
                    description: <p class="mb-2">Resource object representing download</p>
                required:
                - download
                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: []
  /credit_notes/{credit-note-id}/send_einvoice:
    post:
      summary: Send an einvoice for credit notes
      description: |-
        <div class="api-description"><p class="mb-2">This endpoint is used to send an e-invoice for invoice.
        To support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.
        This endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">If e-invoicing is not enabled at the site and customer level.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If there is an e-invoice generated already for the invoice.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the <strong class="font-semibold">Use automatic e-invoicing</strong>  option is selected.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If there are no generated e-invoices with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skipped</code> status.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the invoice status is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">voided</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>.</p>
        </li>
        </ul></div>
      operationId: send_an_einvoice_for_credit_notes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/void:
    post:
      summary: Void a credit note
      description: "Use this API to [void a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note)\
        \ A voided credit is a null entity and cannot be used again. A credit note\
        \ which has already been voided or refunded cannot be voided. An error message\
        \ will be displayed when you render such credit notes void.  \n**Note:**\n\
        When adjustment credit notes are voided, the associated invoice will reflect\
        \ as NOT PAID, and the amount in the invoice will be recalculated to reflect\
        \ the amount after considering the voided credit note.\n"
      operationId: void_a_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/refund:
    post:
      summary: Refund a credit note
      description: <div class="api-description"><p class="mb-2">Refunds a (<a href="https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note"
        target="_blank">refundable</a>) credit note to the <a href="/docs/api/payment_sources">payment
        source</a> associated with the <a href="/docs/api/transactions">transaction</a>.
        Any <code><a href="/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds">linked_tax_withheld_refunds</a></code>
        recorded against the credit note are not refunded.</p></div>
      operationId: refund_a_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                refund_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount to be refunded. If not specified, the entire <a href="/docs/api/credit_notes/credit_note-object#amount_available">refundable amount</a>
                    for this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
                    is refunded.</p>
                    <p class="mb-2"><strong class="font-semibold">Note:</strong>
                    Any <code><a href="/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds">linked_tax_withheld_refunds</a></code>
                    associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
                    cannot be refunded via this operation.</p>
                  minimum: 1
                  example: null
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    A note to be added for this operation, to the credit note. This note is displayed on customer-facing documents such as the [Credit Note PDF](/docs/api/credit_notes/retrieve-credit-note-as-pdf)
                    .
                  maxLength: 2000
                  example: null
                refund_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for the refund. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Refund Credit Note**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - credit_note
                - transaction
                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: []
  /credit_notes:
    get:
      summary: List credit notes
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Lists all the Credit Notes.</p></div>
      operationId: list_credit_notes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted**
          ' attribute will be '**true**
          '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Credit-note id.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "CN_123"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: CN_123
          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: customer_id
        in: query
        description: |
          optional, string filter

          The identifier of the customer this Credit Note belongs to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is\] = "4gmiXbsjdm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 4gmiXbsjdm
          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: subscription_id
        in: query
        description: |
          optional, string filter

          To filter based on subscription_id.
          NOTE: Not to be used if *consolidated invoicing*
          feature is enabled.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *subscription_id\[is\] = "4gmiXbsjdm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 4gmiXbsjdm
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: reference_invoice_id
        in: query
        description: |
          optional, string filter

          The identifier of the invoice against which this Credit Note is issued.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *reference_invoice_id\[is\] = "INVOICE_876"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: INVOICE_876
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: type
        in: query
        description: |
          optional, enumerated string filter

          The credit note type. Possible values are : adjustment, refundable.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *type\[is\] = "adjustment"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: adjustment
          properties:
            is:
              type: string
              description: |
                \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
              enum:
              - adjustment
              - refundable
              - store
              example: null
            is_not:
              type: string
              description: |
                \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
              enum:
              - adjustment
              - refundable
              - store
              example: null
            in:
              type: string
              description: |
                \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
              enum:
              - adjustment
              - refundable
              - store
              pattern: "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
              enum:
              - adjustment
              - refundable
              - store
              pattern: "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\\
                ]$"
              example: null
      - name: reason_code
        in: query
        description: |
          optional, enumerated string filter

          The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
          parameter instead\]. Possible values are : write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *reason_code\[is\] = "waiver"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: waiver
          properties:
            is:
              type: string
              description: |
                \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
              enum:
              - write_off
              - subscription_change
              - subscription_cancellation
              - subscription_pause
              - chargeback
              - product_unsatisfactory
              - service_unsatisfactory
              - order_change
              - order_cancellation
              - waiver
              - other
              - fraudulent
              example: null
            is_not:
              type: string
              description: |
                \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
              enum:
              - write_off
              - subscription_change
              - subscription_cancellation
              - subscription_pause
              - chargeback
              - product_unsatisfactory
              - service_unsatisfactory
              - order_change
              - order_cancellation
              - waiver
              - other
              - fraudulent
              example: null
            in:
              type: string
              description: |
                \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
              enum:
              - write_off
              - subscription_change
              - subscription_cancellation
              - subscription_pause
              - chargeback
              - product_unsatisfactory
              - service_unsatisfactory
              - order_change
              - order_cancellation
              - waiver
              - other
              - fraudulent
              pattern: "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
              enum:
              - write_off
              - subscription_change
              - subscription_cancellation
              - subscription_pause
              - chargeback
              - product_unsatisfactory
              - service_unsatisfactory
              - order_change
              - order_cancellation
              - waiver
              - other
              - fraudulent
              pattern: "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\\
                ]$"
              example: null
      - name: create_reason_code
        in: query
        description: |
          optional, string filter

          Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note** .
          Must be passed if set as mandatory in the app. The codes are case-sensitive.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *create_reason_code\[is\] = "Other"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Other
          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: status
        in: query
        description: |
          optional, enumerated string filter

          The credit note status. Possible values are : adjusted, refunded, refund_due, voided.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "adjusted"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: adjusted
          properties:
            is:
              type: string
              description: |
                \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
              enum:
              - adjusted
              - refunded
              - refund_due
              - voided
              example: null
            is_not:
              type: string
              description: |
                \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
              enum:
              - adjusted
              - refunded
              - refund_due
              - voided
              example: null
            in:
              type: string
              description: |
                \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
              enum:
              - adjusted
              - refunded
              - refund_due
              - voided
              pattern: "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
              enum:
              - adjusted
              - refunded
              - refund_due
              - voided
              pattern: "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\\
                ]$"
              example: null
      - name: date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The date the Credit Note is issued.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *date\[on\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: total
        in: query
        description: |
          optional, in cents filter

          Credit Note amount in cents.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *total\[lte\] = "1200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: price_type
        in: query
        description: |
          optional, enumerated string filter

          The price type of the Credit Note. Possible values are : tax_exclusive, tax_inclusive.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *price_type\[is\] = "tax_exclusive"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: tax_exclusive
          properties:
            is:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            is_not:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            in:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                ]$"
              example: null
      - name: amount_allocated
        in: query
        description: |
          optional, in cents filter

          The amount allocated to the invoices.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_allocated\[gt\] = "1200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_refunded
        in: query
        description: |
          optional, in cents filter

          The refunds issued from this Credit Note.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_refunded\[is\] = "130"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "130"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_available
        in: query
        description: |
          optional, in cents filter

          The yet to be used credits of this Credit Note.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_available\[gt\] = "1400"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1400"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: voided_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating the date and time this Credit Note gets voided.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *voided_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              example: null
            desc:
              type: string
              enum:
              - date
              example: null
          example: null
      - name: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      - name: einvoice
        in: query
        description: |
          Parameters for einvoice
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            status:
              type: object
              deprecated: false
              description: |-
                <p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                , see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code>
                .</p>
              example: failed
              properties:
                is:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  example: null
                is_not:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  example: null
                in:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  pattern: "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\\
                    ]$"
                  example: null
                not_in:
                  type: string
                  description: |-
                    * `scheduled` - Sending the e-invoice to the customer has been scheduled.
                    * `skipped` - The e-invoice was not sent. This could be due to missing information or because the <code>entity_identifier</code> is not registered on the e-invoicing network.
                    * `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                    * `success` - The e-invoice has been successfully delivered to the customer.
                    * `failed` - The e-invoice was sent and there was an error due to which it was not delivered.
                    * `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                    * `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                    * `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
                    * `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                    * `in_process` - The e-invoice is currently being processed by the receiving entity.
                    * `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                    * `conditionally_accepted` - The e-invoice has been accepted with conditions.
                    * `paid` - The receiving entity has confirmed that the e-invoice has been paid.
                  enum:
                  - scheduled
                  - skipped
                  - in_progress
                  - success
                  - failed
                  - registered
                  - accepted
                  - rejected
                  - message_acknowledgement
                  - in_process
                  - under_query
                  - conditionally_accepted
                  - paid
                  pattern: "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\\
                    ]$"
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        credit_note:
                          $ref: "#/components/schemas/CreditNote"
                          description: Resource object representing credit_note
                      required:
                      - credit_note
                      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: []
    post:
      summary: Create credit note
      description: "<div class=\"api-description\"><p class=\"mb-2\">Creates a <code\
        \ class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded\
        \ px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">credit_note</code>\
        \ for the specified invoice.</p><div class=\"alert alert-info\"><p class=\"\
        mb-2\"><strong class=\"font-semibold\">Note:</strong></p><p class=\"mb-2\"\
        >If the <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">credit_note</code>\
        \ <code><a href=\"/docs/api/credit_notes/create-credit-note#type\">type</a></code>\
        \ is <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">refundable</code>,\
        \ then <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">linked_taxes_withheld.amount</code>\
        \ for the <a href=\"/docs/api/credit_notes/create-credit-note#reference_invoice_id\"\
        >invoice specified</a> can also be included in the <code><a href=\"/docs/api/credit_notes/create-credit-note#total\"\
        >total</a></code>.</p></div></div>"
      operationId: create_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                reference_invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the invoice against which this Credit Note is issued.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                total:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |
                    Credit Note amount in cents. You can either pass the total parameter or the line_items parameter. Passing both will result in an error.
                  minimum: 0
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)
                    about credit note types.
                    \* refundable -

                    Refundable Credit Note
                    \* store -

                    Store Credit Note
                    \* adjustment -

                    Adjustment Credit Note
                  enum:
                  - adjustment
                  - refundable
                  - store
                  example: null
                reason_code:
                  type: string
                  deprecated: false
                  description: |
                    The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
                    parameter instead\].
                    \* chargeback -

                    Can be set when you are recording your customer Chargebacks
                    \* subscription_change -

                    This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                    is enabled
                    \* waiver -

                    Waiver
                    \* order_cancellation -

                    Order Cancellation
                    \* order_change -

                    Order Change
                    \* product_unsatisfactory -

                    Product Unsatisfactory
                    \* subscription_pause -

                    This reason will be automatically set to credit notes created during pause/resume subscription operation.
                    \* service_unsatisfactory -

                    Service Unsatisfactory
                    \* other -

                    Can be set when none of the above reason codes are applicable
                    \* subscription_cancellation -

                    This reason will be set automatically for Credit Notes created during cancel subscription operation
                    \* write_off -

                    This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                    operation.
                    \* fraudulent -

                    FRAUDULENT
                  enum:
                  - product_unsatisfactory
                  - service_unsatisfactory
                  - order_change
                  - order_cancellation
                  - waiver
                  - other
                  example: null
                create_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date the Credit Note is issued.
                  example: null
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    A note to be added for this operation, to the credit note. This note is displayed on customer-facing documents such as the [Credit Note PDF](/docs/api/credit_notes/retrieve-credit-note-as-pdf)
                    .
                  maxLength: 2000
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  maxLength: 3
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the credit note. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Credit Note PDF](/docs/api/credit_notes/retrieve-credit-note-as-pdf)
                    .
                  maxLength: 300
                  example: null
                line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line_items
                  properties:
                    reference_line_item_id:
                      type: array
                      description: |
                        Uniquely identifies a line_item
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        Unit amount of the line item. Required for FLAT_FEE, PER_UNIT and VOLUME pricing model.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Applicable for the line_item when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Quantity of the line item. Required for PER_UNIT and VOLUME pricing model.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        Applicable for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                        and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        Amount of the line item. Applicable only for STAIRSTEP, TIERED pricing_model.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        Start date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        End date of this line item.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for the line item.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          null
                        enum:
                        - plan
                        - addon
                        - adhoc
                        example: null
                      example: null
                    entity_id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
              required:
              - type
              example: null
            encoding:
              line_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/download_einvoice:
    get:
      summary: Download e-invoice for credit note
      description: |-
        <div class="api-description"><span featureId="cb-einvoicing"></span><p class="mb-2">Download the e-invoice for the credit note in both XML and PDF formats. The response consists of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">download</code> object for each format. The XML format follows the <a href="https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/tree/" target="_blank" rel="noopener noreferrer">structure as per Peppol BIS Billing v3.0</a>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">You can only download e-invoices when their <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">registered</code>.</li>
        <li class="text-base leading-relaxed">There are some cases in which the PDF is not available for download. In such cases, you can obtain it from the XML by decoding the value for <code><a href="https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AdditionalDocumentReference/cac-Attachment/cbc-EmbeddedDocumentBinaryObject/" target="_blank" rel="noopener noreferrer">cbc:EmbeddedDocumentBinaryObject</a></code>, which is the Base64-encoded version of the PDF.</li>
        </ul></div></div>
      operationId: download_e-invoice_for_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloads:
                    type: array
                    description: <p class="mb-2">Resource object representing download</p>
                    items:
                      $ref: "#/components/schemas/Download"
                      description: Resource object representing download
                    example: null
                required:
                - downloads
                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: []
  /credit_notes/{credit-note-id}/resend_einvoice:
    post:
      summary: Resend failed einvoice in credit notes
      description: |
        Resend failed einvoice in credit notes.
      operationId: resend_failed_einvoice_in_credit_notes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}/remove_tax_withheld_refund:
    post:
      summary: Remove tax withheld refunds from a credit note
      description: |-
        <div class="api-description"><span featureId="cb-tax-withheld"></span><p class="mb-2">Removes a <code><a href="/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds">linked_tax_withheld_refunds</a></code>
        record from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>
        .</p></div>
      operationId: remove_tax_withheld_refunds_from_a_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                tax_withheld:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_withheld
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_</code>.
                        For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_16BdDXSlbu4uV1Ee6</code>
                        .</p>
                      maxLength: 40
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              tax_withheld:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /credit_notes/{credit-note-id}:
    get:
      summary: Retrieve a credit note
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Retrieves the Credit Note identified by the specified Credit Note number.</p></div>
      operationId: retrieve_a_credit_note
      parameters:
      - name: line_items_limit
        in: query
        description: "Specify the maximum number of line items to include in the response.\
          \  \n**Note:**\n\n* Applicable only when Enterprise-scale Invoicing is enabled.\n\
          * Enterprise-scale Invoicing is currently in **Private Beta** . Please reach\
          \ out to [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)\
          \ to enable this feature.\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          deprecated: false
          maximum: 300
          minimum: 1
          example: null
      - name: line_items_offset
        in: query
        description: |-
          <p class="mb-2">Specify the starting point for retrieving line items. Use the value from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items_next_offset</code> attribute of the previous retrieve API response.</p>
          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
          <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li>
          <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this feature.</li>
          </ul></div>
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 1000
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: credit-note-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-note-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                required:
                - credit_note
                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: []
  /unbilled_charges/{unbilled-charge-id}/delete:
    post:
      summary: Delete an unbilled charge
      description: |
        Use this API to delete an unbilled charge by specifying the id of the charge.
      operationId: delete_an_unbilled_charge
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: unbilled-charge-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/unbilled-charge-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  unbilled_charge:
                    $ref: "#/components/schemas/UnbilledCharge"
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                required:
                - unbilled_charge
                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: []
  /unbilled_charges/invoice_now_estimate:
    post:
      summary: Create an estimate for unbilled charges
      description: |
        This is similar to the "Create an invoice for unbilled charges" API but no invoice will be created, only an estimate for this operation is created.

        In the estimate response,

        * **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.

        **Note:**

        * This API when invoked does not perform the actual operation. It just generates an estimate.
        * Both *subscription_id* and *customer_id* parameters should not be given at the same time.
      operationId: create_an_estimate_for_unbilled_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this estimate needs to be created. Should be given if 'customer_id' is not specified.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for whom this estimate is created. Is given if 'subscription_id' is not specified. Applicable only if the 'Consolidated Invoicing' is enabled. If 'Consolidated Invoicing' is not enabled, an invoice will be generated for every subscription.
                  maxLength: 50
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /unbilled_charges/invoice_unbilled_charges:
    post:
      summary: Create an invoice for unbilled charges
      description: |
        Use this API to bill the [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). Available Credits and Excess Payments will automatically be applied while creating the invoice.

        If the *Auto Collection* is turned on for the particular customer, the invoice will be created in payment_due state and the payment collection will be scheduled immediately.

        During invoice creation, the PO number for the line items will be filled from the subscription's current PO number, if available.

        If no recurring item is present in the created invoice, the invoice will be marked as recurring=false.

        If consolidated invoicing is enabled and the parameter 'customer_id' is passed, multiple invoices can be created based on the following factors.

        * Currency
        * PO number if 'Group by PO number' is enabled
        * Shipping address
        * Auto Collection
        * Payment method
      operationId: create_an_invoice_for_unbilled_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for whom this invoice needs to be created. Should be specified if 'subscription_id' is not specified. Applicable only if the consolidated invoicing is enabled. .
                  maxLength: 50
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoices:
                    type: array
                    description: <p class="mb-2">Resource object representing invoice</p>
                    items:
                      $ref: "#/components/schemas/Invoice"
                      description: <p class="mb-2">Resource object representing invoice</p>
                    example: null
                required:
                - invoices
                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: []
  /unbilled_charges:
    get:
      summary: List unbilled charges
      description: |
        This endpoint lists all the unbilled charges.
      operationId: list_unbilled_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\*\\\\\\\*deleted\\\\\\\*\\\\\\\* ' attribute will be '\\\\\\\*\\\\\\\*true\\\\\\\*\\\\\\\* '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: is_voided
        in: query
        description: |
          Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          deprecated: false
          example: null
      - name: subscription_id
        in: query
        description: |
          optional, string filter

          A unique identifier for the subscription this charge belongs to.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *subscription_id\[is\] = "5hjdk8nOpd0b12"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 5hjdk8nOpd0b12
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          A unique identifier for the customer being charged.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *customer_id\[is\] = "5hjdk8nOpd0b12"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 5hjdk8nOpd0b12
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        unbilled_charge:
                          $ref: "#/components/schemas/UnbilledCharge"
                          description: Resource object representing unbilled_charge
                      required:
                      - unbilled_charge
                      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: []
  /unbilled_charges/create:
    post:
      summary: Create unbilled charges for a subscription
      description: |
        Create unbilled charges for a subscription using this API.
      operationId: create_unbilled_charges_for_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the subscription for which this unbilled charges needs to be created.
                  maxLength: 50
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the unbilled_charge.
                  maxLength: 3
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).
                        Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )
                        can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the addon starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the addon ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                        Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    taxable:
                      type: array
                      description: |
                        The amount to be charged is taxable or not.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    tax_profile_id:
                      type: array
                      description: |
                        Tax profile of the charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_tax_code:
                      type: array
                      description: |
                        The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    hsn_code:
                      type: array
                      description: |
                        The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                        to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                        * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                        * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    taxjar_product_code:
                      type: array
                      description: |
                        The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                          \* retail -

                          Transaction is a sale to an end user
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the charge starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the charge ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              required:
              - subscription_id
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - unbilled_charges
                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: []
  /orders:
    get:
      summary: List orders
      description: |
        This API is used to retrieve a list of all the available orders.
      operationId: list_orders
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\*\\\\\\\*deleted\\\\\\\*\\\\\\\* ' attribute will be '\\\\\\\*\\\\\\\*true\\\\\\\*\\\\\\\* '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: exclude_deleted_credit_notes
        in: query
        description: |
          Flag to indicate whether deleted credit notes should be passed or not.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          deprecated: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Uniquely identifies the order. It is the api identifier for the order.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is_not\] = "890"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "890"
          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: invoice_id
        in: query
        description: |
          optional, string filter

          The invoice number which acts as an identifier for invoice and is generated sequentially.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *invoice_id\[is\] = "INVOICE_982"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: INVOICE_982
          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: subscription_id
        in: query
        description: |
          optional, string filter

          The subscription for which the order is created.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *subscription_id\[is_not\] = "null"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          The status of this order. Possible values are : new, processing, complete, cancelled, voided, queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "queued"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: queued
          properties:
            is:
              type: string
              description: |
                \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
              enum:
              - new
              - processing
              - complete
              - cancelled
              - voided
              - queued
              - awaiting_shipment
              - on_hold
              - delivered
              - shipped
              - partially_delivered
              - returned
              example: null
            is_not:
              type: string
              description: |
                \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
              enum:
              - new
              - processing
              - complete
              - cancelled
              - voided
              - queued
              - awaiting_shipment
              - on_hold
              - delivered
              - shipped
              - partially_delivered
              - returned
              example: null
            in:
              type: string
              description: |
                \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
              enum:
              - new
              - processing
              - complete
              - cancelled
              - voided
              - queued
              - awaiting_shipment
              - on_hold
              - delivered
              - shipped
              - partially_delivered
              - returned
              pattern: "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
              enum:
              - new
              - processing
              - complete
              - cancelled
              - voided
              - queued
              - awaiting_shipment
              - on_hold
              - delivered
              - shipped
              - partially_delivered
              - returned
              pattern: "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\\
                ]$"
              example: null
      - name: shipping_date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          This is the date on which the order will be delivered to the customer.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *shipping_date\[on\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: shipped_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The time at which the order was shipped.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *shipped_at\[before\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: order_type
        in: query
        description: |
          optional, enumerated string filter

          Order type. Possible values are : manual, system_generated.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *order_type\[is_not\] = "system_generated"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: system_generated
          properties:
            is:
              type: string
              description: |
                \* \`manual\` - The order has been created by the the user using Chargebee's legacy order management system. \* \`system_generated\` - The order has been created by Chargebee automatically based on the preferences set by the user.
              enum:
              - manual
              - system_generated
              example: null
            is_not:
              type: string
              description: |
                \* \`manual\` - The order has been created by the the user using Chargebee's legacy order management system. \* \`system_generated\` - The order has been created by Chargebee automatically based on the preferences set by the user.
              enum:
              - manual
              - system_generated
              example: null
            in:
              type: string
              description: |
                \* \`manual\` - The order has been created by the the user using Chargebee's legacy order management system. \* \`system_generated\` - The order has been created by Chargebee automatically based on the preferences set by the user.
              enum:
              - manual
              - system_generated
              pattern: "^\\[(manual|system_generated)(,(manual|system_generated))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`manual\` - The order has been created by the the user using Chargebee's legacy order management system. \* \`system_generated\` - The order has been created by Chargebee automatically based on the preferences set by the user.
              enum:
              - manual
              - system_generated
              pattern: "^\\[(manual|system_generated)(,(manual|system_generated))*\\\
                ]$"
              example: null
      - name: order_date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The date on which the order will start getting processed.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *order_date\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: paid_on
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The timestamp indicating the date \& time the order's invoice got paid.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *paid_on\[before\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The time at which the order was created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: resent_status
        in: query
        description: |
          optional, enumerated string filter

          Resent order status. Possible values are : fully_resent, partially_resent.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *resent_status\[is\] = "fully_resent"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: fully_resent
          properties:
            is:
              type: string
              description: |
                \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
              enum:
              - fully_resent
              - partially_resent
              example: null
            is_not:
              type: string
              description: |
                \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
              enum:
              - fully_resent
              - partially_resent
              example: null
            in:
              type: string
              description: |
                \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
              enum:
              - fully_resent
              - partially_resent
              pattern: "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
              enum:
              - fully_resent
              - partially_resent
              pattern: "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\\
                ]$"
              example: null
      - name: is_resent
        in: query
        description: |
          optional, boolean filter

          Order is resent order or not. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *is_resent\[is\] = "false"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "false"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: original_order_id
        in: query
        description: |
          optional, string filter

          If resent order what is the parent order id.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *original_order_id\[is\] = "1xRt6ifdr"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 1xRt6ifdr
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        order:
                          $ref: "#/components/schemas/Order"
                          description: Resource object representing order
                      required:
                      - order
                      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: []
    post:
      summary: Create an order
      description: |
        #### Deprecated

        Chargebee no longer supports this endpoint, see [here](https://www.chargebee.com/docs/1.0/manual_orders_deprecate.html)
        for more information. Contact [Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)
        for additional assistance or if you have concerns about this update.
      operationId: create_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Uniquely identifies the order. If not given, this will be auto-generated.
                  maxLength: 40
                  example: null
                invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    The invoice number which acts as an identifier for invoice and is generated sequentially.
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The order status.
                    \* cancelled -

                    Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system
                    \* new -

                    Order has been created. Applicable only if you are using Chargebee's legacy order management system.
                    \* voided -

                    Order has been voided. Applicable only if you are using Chargebee's legacy order management system
                    \* complete -

                    Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system
                    \* processing -

                    Order is being processed. Applicable only if you are using Chargebee's legacy order management system
                  enum:
                  - new
                  - processing
                  - complete
                  - cancelled
                  - voided
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: |
                    Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.
                  maxLength: 50
                  example: null
                fulfillment_status:
                  type: string
                  deprecated: false
                  description: |
                    The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.
                  maxLength: 50
                  example: null
                note:
                  type: string
                  deprecated: false
                  description: |
                    The custom note for the order.
                  maxLength: 600
                  example: null
                tracking_id:
                  type: string
                  deprecated: false
                  description: |
                    The tracking id of the order.
                  maxLength: 50
                  example: null
                tracking_url:
                  type: string
                  deprecated: false
                  description: |
                    The tracking url of the order.
                  maxLength: 255
                  example: null
                batch_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique id to identify a group of orders.
                  maxLength: 50
                  example: null
              required:
              - invoice_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/import_order:
    post:
      summary: Import an order
      description: |
        Import an order for an invoice with one or more line items.
      operationId: import_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Uniquely identifies the order. It is the api identifier for the order.

                    \*Order id will always be assigned incrementally from the last generated Order ID.

                    If Orders imported has an Order ID which is a string, Chargebee will just validate if the Order ID is unique

                    Recommendation: For orders being imported, set the same prefix and the serial number that is used for the Document number, which will make this into a string. This will ensure that imported orders don't conflict with orders created by Chargebee. Chargebee will ensure there aren't orders with duplicate Order IDs.\*
                    .
                  maxLength: 40
                  example: null
                document_number:
                  type: string
                  deprecated: false
                  description: |
                    The order's serial number.

                    *Document number passed cannot be greater than the series mentioned in the configuration. For instance, if you have set Document number series in Order Configurations with a Prefix as 'ORDER' and Starting number as '1000', orders up to the sequence number 'ORDER999' can be imported into Chargebee*

                    *Recommendation: Set a different prefix at the Order Configuration, than the ones that are imported. If your Order Configuration has a Prefix of 'NEW', with Starting number as '1', i.e. 'NEW1', then, set Prefix for imported orders to be as 'OLD', with Starting number as '1', i.e, 'OLD1'*
                    .
                  maxLength: 50
                  example: null
                invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    The invoice number which acts as an identifier for invoice and is generated sequentially.
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The status of this order.
                    \* voided -

                    Order has been voided. Applicable only if you are using Chargebee's legacy order management system
                    \* complete -

                    Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system
                    \* shipped -

                    The order has moved from order management system to a shipping system.
                    \* processing -

                    Order is being processed. Applicable only if you are using Chargebee's legacy order management system
                    \* queued -

                    Order is yet to be processed by any system, these are scheduled orders created by Chargebee
                    \* on_hold -

                    The order is paused from being processed.
                    \* new -

                    Order has been created. Applicable only if you are using Chargebee's legacy order management system.
                    \* returned -

                    The order has been returned after delivery.
                    \* delivered -

                    The order has been delivered to the customer.
                    \* awaiting_shipment -

                    The order has been picked up by an integration system, and synced to a shipping management platform
                    \* cancelled -

                    Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system
                    \* partially_delivered -

                    The order has been partially delivered to the customer.
                  enum:
                  - cancelled
                  - queued
                  - awaiting_shipment
                  - on_hold
                  - delivered
                  - shipped
                  - partially_delivered
                  - returned
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The subscription for which the order is created.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    The customer for which the order is created.
                  maxLength: 50
                  example: null
                created_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was created.
                  example: null
                order_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date on which the order will start getting processed.
                  example: null
                shipping_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    This is the date on which the order has to be shipped to the customer.
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: |
                    Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is the same as the order id in the third party application.

                    *Recommendation:
                    If this order is in any of these statuses, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned, and has already been processed, through a 3rd party system, and you have a reference id of the entity in the 3rd party tool, pass in the entity id to this field. If not, set the same prefix and the serial number that is used for the Document number, which will make this into a string.*

                    *If this order hasn't been processed and is in 'queued' status, do not pass any value to this field. Chargebee, when it syncs your Orders through the fulfilment integrations such as Shipstation or Shopify, would auto assign the reference id from the connected system.*
                    .
                  maxLength: 50
                  example: null
                fulfillment_status:
                  type: string
                  deprecated: false
                  description: |
                    The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.

                    \*If this order is in any of these statuses, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned, and has already been processed, through a 3rd party system, and you have a corresponding status from the 3rd party tool, pass in the status to this field.

                    If this order hasn't been processed and is in 'queued' status, do not pass any value to this field. Chargebee, when it syncs your Orders through the fulfilment integrations such as Shipstation or Shopify, would auto assign the fulfilment status from the connected system.\*
                    .
                  maxLength: 50
                  example: null
                note:
                  type: string
                  deprecated: false
                  description: |
                    The custom note for the order.
                  maxLength: 600
                  example: null
                tracking_id:
                  type: string
                  deprecated: false
                  description: |
                    The tracking id of the order.
                  maxLength: 50
                  example: null
                tracking_url:
                  type: string
                  deprecated: false
                  description: |
                    The tracking url of the order.
                  maxLength: 255
                  example: null
                batch_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique id to identify a group of orders.
                  maxLength: 50
                  example: null
                shipment_carrier:
                  type: string
                  deprecated: false
                  description: |
                    Shipment carrier.
                  maxLength: 50
                  example: null
                shipping_cut_off_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time after which an order becomes unservicable.
                  example: null
                delivered_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was delivered.
                  example: null
                shipped_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was shipped.
                  example: null
                cancelled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was cancelled.
                  example: null
                cancellation_reason:
                  type: string
                  deprecated: false
                  description: |
                    Cancellation reason.
                    \* shipping_cut_off_passed -

                    The invoice has been paid late and Chargebee cancel's the first order for the invoice.
                    \* invoice_voided -

                    The invoice for which the order was createed has been voided.
                    \* alternative_found -

                    Alternative found.
                    \* others -

                    Other reason
                    \* order_resent -

                    Order resent
                    \* product_unsatisfactory -

                    Product unsatisfactory.
                    \* delivery_date_missed -

                    Delivery date missed.
                    \* subscription_cancelled -

                    The subsctiption for which the order was created has been cancelled.
                    \* fraudulent_transaction -

                    Fraudulent transaction.
                    \* invoice_written_off -

                    The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.
                    \* product_not_required -

                    Product not required.
                    \* payment_declined -

                    Payment declined.
                    \* product_not_available -

                    Product not available.
                    \* third_party_cancellation -

                    Third party cancellation.
                  enum:
                  - shipping_cut_off_passed
                  - product_unsatisfactory
                  - third_party_cancellation
                  - product_not_required
                  - delivery_date_missed
                  - alternative_found
                  - invoice_written_off
                  - invoice_voided
                  - fraudulent_transaction
                  - payment_declined
                  - subscription_cancelled
                  - product_not_available
                  - others
                  - order_resent
                  example: null
                refundable_credits_issued:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    If there are any credits that were issued at the order level, you can make use of the field, refundable_credits_issued. This will lead to Chargebee creating a Refundable Credit note against the order. When the next invoice is raised against the customer, this credit note will be utilised.
                  minimum: 0
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
              required:
              - created_at
              - invoice_id
              - order_date
              - shipping_date
              - status
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/assign_order_number:
    post:
      summary: Assign order number
      description: |
        Assigns order number to the order based on the settings, if not already assigned
      operationId: assign_order_number
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/resend:
    post:
      summary: Resend an order
      description: |
        Resend an existing order. This will help in resending an existing order in full or partial. Upto 5 resend operations are allowed per . When resent fully, the original order is canceled.
      operationId: resend_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                shipping_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date on which the order should be shipped to the customer.
                  example: null
                resend_reason:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for resending the order. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Orders \> Order Resend**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                order_line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for order_line_items
                  properties:
                    id:
                      type: array
                      description: |
                        The identifier for the order line item.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    fulfillment_quantity:
                      type: array
                      description: |
                        The quantity that is going to get fulfilled for this order
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              order_line_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/reopen:
    post:
      summary: Reopen a cancelled order
      description: |
        This API is used to re-open a cancelled order
      operationId: reopen_a_cancelled_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                void_cancellation_credit_notes:
                  type: boolean
                  deprecated: false
                  description: |
                    Flag to void credit notes created for cancellation if they are unused.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/cancel:
    post:
      summary: Cancel an order
      description: |
        Cancel order and create a refundable credit note for the order
      operationId: cancel_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                cancellation_reason:
                  type: string
                  deprecated: false
                  description: |
                    Cancellation reason.
                    \* shipping_cut_off_passed -

                    The invoice has been paid late and Chargebee cancel's the first order for the invoice.
                    \* alternative_found -

                    Alternative found.
                    \* others -

                    Other reason
                    \* product_unsatisfactory -

                    Product unsatisfactory.
                    \* product_not_required -

                    Product not required.
                    \* delivery_date_missed -

                    Delivery date missed.
                    \* invoice_voided -

                    The invoice for which the order was createed has been voided.
                    \* payment_declined -

                    Payment declined.
                    \* product_not_available -

                    Product not available.
                    \* subscription_cancelled -

                    The subsctiption for which the order was created has been cancelled.
                    \* third_party_cancellation -

                    Third party cancellation.
                    \* fraudulent_transaction -

                    Fraudulent transaction.
                    \* order_resent -

                    Order resent
                    \* invoice_written_off -

                    The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.
                  enum:
                  - shipping_cut_off_passed
                  - product_unsatisfactory
                  - third_party_cancellation
                  - product_not_required
                  - delivery_date_missed
                  - alternative_found
                  - invoice_written_off
                  - invoice_voided
                  - fraudulent_transaction
                  - payment_declined
                  - subscription_cancelled
                  - product_not_available
                  - others
                  - order_resent
                  example: null
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    The Customer Notes to be filled in the Credit Notes created to capture this refund detail.
                  maxLength: 2000
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Comment, if any, on the refund.
                  maxLength: 300
                  example: null
                cancelled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was cancelled.
                  example: null
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    total:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |
                        Credit Note amount in cents.
                      minimum: 0
                      example: null
                  example: null
              required:
              - cancellation_reason
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}:
    get:
      summary: Retrieve an order
      description: |
        Retrieves an order corresponding to the order id passed.
      operationId: retrieve_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
    post:
      summary: Update an order
      description: |
        Updates an order. If the status of an order is changed while updating the order, the status_update_at attribute is set with the current time.
      operationId: update_an_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                reference_id:
                  type: string
                  deprecated: false
                  description: |
                    Reference id is the unique identifier of the order in the shipping/order management application.
                  maxLength: 50
                  example: null
                batch_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique id to identify a group of orders.
                  maxLength: 50
                  example: null
                note:
                  type: string
                  deprecated: false
                  description: |
                    The custom note for the order.
                  maxLength: 600
                  example: null
                shipping_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date on which the order should be shipped to the customer.
                  example: null
                order_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The order date.
                  example: null
                cancelled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was cancelled.
                  example: null
                cancellation_reason:
                  type: string
                  deprecated: false
                  description: |
                    Cancellation reason.
                    \* shipping_cut_off_passed -

                    The invoice has been paid late and Chargebee cancel's the first order for the invoice.
                    \* invoice_voided -

                    The invoice for which the order was createed has been voided.
                    \* alternative_found -

                    Alternative found.
                    \* others -

                    Other reason
                    \* order_resent -

                    Order resent
                    \* product_unsatisfactory -

                    Product unsatisfactory.
                    \* delivery_date_missed -

                    Delivery date missed.
                    \* subscription_cancelled -

                    The subsctiption for which the order was created has been cancelled.
                    \* fraudulent_transaction -

                    Fraudulent transaction.
                    \* invoice_written_off -

                    The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.
                    \* product_not_required -

                    Product not required.
                    \* payment_declined -

                    Payment declined.
                    \* product_not_available -

                    Product not available.
                    \* third_party_cancellation -

                    Third party cancellation.
                  enum:
                  - shipping_cut_off_passed
                  - product_unsatisfactory
                  - third_party_cancellation
                  - product_not_required
                  - delivery_date_missed
                  - alternative_found
                  - invoice_written_off
                  - invoice_voided
                  - fraudulent_transaction
                  - payment_declined
                  - subscription_cancelled
                  - product_not_available
                  - others
                  - order_resent
                  example: null
                shipped_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was shipped.
                  example: null
                delivered_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the order was delivered.
                  example: null
                tracking_url:
                  type: string
                  deprecated: false
                  description: |
                    The tracking url of the order.
                  maxLength: 255
                  example: null
                tracking_id:
                  type: string
                  deprecated: false
                  description: |
                    The tracking id of the order.
                  maxLength: 50
                  example: null
                shipment_carrier:
                  type: string
                  deprecated: false
                  description: |
                    The carrier used to ship the goods to the customer. Ex:- FedEx.
                  maxLength: 50
                  example: null
                fulfillment_status:
                  type: string
                  deprecated: false
                  description: |
                    The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.
                  maxLength: 50
                  example: null
                status:
                  type: string
                  default: new
                  deprecated: false
                  description: |
                    The order status.
                    \* voided -

                    Order has been voided. Applicable only if you are using Chargebee's legacy order management system
                    \* complete -

                    Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system
                    \* shipped -

                    The order has moved from order management system to a shipping system.
                    \* processing -

                    Order is being processed. Applicable only if you are using Chargebee's legacy order management system
                    \* queued -

                    Order is yet to be processed by any system, these are scheduled orders created by Chargebee
                    \* on_hold -

                    The order is paused from being processed.
                    \* new -

                    Order has been created. Applicable only if you are using Chargebee's legacy order management system.
                    \* returned -

                    The order has been returned after delivery.
                    \* delivered -

                    The order has been delivered to the customer.
                    \* awaiting_shipment -

                    The order has been picked up by an integration system, and synced to a shipping management platform
                    \* cancelled -

                    Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system
                    \* partially_delivered -

                    The order has been partially delivered to the customer.
                  enum:
                  - new
                  - processing
                  - complete
                  - cancelled
                  - voided
                  - queued
                  - awaiting_shipment
                  - on_hold
                  - delivered
                  - shipped
                  - partially_delivered
                  - returned
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                order_line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for order_line_items
                  properties:
                    id:
                      type: array
                      description: |
                        The identifier for the order line item.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    status:
                      type: array
                      items:
                        type: string
                        default: queued
                        deprecated: false
                        description: |
                          The order line item's delivery status
                          \* shipped -

                          The order line item has been shipped.
                          \* returned -

                          The order has been returned after delivery.
                          \* queued -

                          Not processed for shipping yet.
                          \* awaiting_shipment -

                          Moved to shipping platform.
                          \* on_hold -

                          The delivery has been moved to "On hold" status.
                          \* partially_delivered -

                          The order has been partially delivered to the customer.
                          \* cancelled -

                          The order has been returned after delivery.
                          \* delivered -

                          The order line item has been delivered.
                        enum:
                        - queued
                        - awaiting_shipment
                        - on_hold
                        - delivered
                        - shipped
                        - partially_delivered
                        - returned
                        - cancelled
                        example: null
                      example: null
                    sku:
                      type: array
                      description: |
                        The SKU code for the order line item product
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              order_line_items:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/delete:
    post:
      summary: Delete an imported order
      description: |
        Deletes only [Imported Order](/docs/api/v2/pcv-1/orders/import-an-order)
        .Delete does not happen if the order was refunded. It goes through if order refund was initiated and is in "refund_due" state.
      operationId: delete_an_imported_order
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /orders/{order-id}/create_refundable_credit_note:
    post:
      summary: Create a refundable credit note
      description: |
        This API is used to create a refundable credit note for the order
      operationId: create_a_refundable_credit_note
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_notes:
                  type: string
                  deprecated: false
                  description: |
                    The Customer Notes to be filled in the Credit Notes created to capture this refund detail.
                  maxLength: 2000
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Comment, if any, on the refund.
                  maxLength: 300
                  example: null
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    reason_code:
                      type: string
                      deprecated: false
                      description: |
                        The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
                        parameter instead\]
                        \* product_unsatisfactory -

                        Product Unsatisfactory
                        \* chargeback -

                        Can be set when you are recording your customer Chargebacks
                        \* service_unsatisfactory -

                        Service Unsatisfactory
                        \* write_off -

                        This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                        operation.
                        \* subscription_change -

                        This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                        is enabled
                        \* fraudulent -

                        FRAUDULENT
                        \* other -

                        Can be set when none of the above reason codes are applicable
                        \* subscription_pause -

                        This reason will be automatically set to credit notes created during pause/resume subscription operation.
                        \* waiver -

                        Waiver
                        \* order_cancellation -

                        Order Cancellation
                        \* order_change -

                        Order Change
                        \* subscription_cancellation -

                        This reason will be set automatically for Credit Notes created during cancel subscription operation
                      enum:
                      - write_off
                      - subscription_change
                      - subscription_cancellation
                      - subscription_pause
                      - chargeback
                      - product_unsatisfactory
                      - service_unsatisfactory
                      - order_change
                      - order_cancellation
                      - waiver
                      - other
                      - fraudulent
                      example: null
                    total:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |
                        Credit Note amount in cents.
                      minimum: 0
                      example: null
                  required:
                  - reason_code
                  - total
                  example: null
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: "#/components/schemas/Order"
                    description: <p class="mb-2">Resource object representing order</p>
                required:
                - order
                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: []
  /gifts/{gift-id}/cancel:
    post:
      summary: Cancel a gift
      description: |
        This API allows to cancel gifts. Only gift in 'scheduled' and 'unclaimed' states can be cancelled.
      operationId: cancel_a_gift
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: gift-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/gift-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: <p class="mb-2">Resource object representing gift</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                required:
                - gift
                - subscription
                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: []
  /gifts/{gift-id}/update_gift:
    post:
      summary: Update a gift
      description: |
        Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled [status](/docs/api/gifts/gift-object#status)
        .
      operationId: update_a_gift
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: gift-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/gift-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The new date/time at which the gift notification email is to be sent. The value must be greater than current time. If [no_expiry](/docs/api/gifts/gift-object#no_expiry)
                    is false then the value must also be less than [claim_expiry_date](/docs/api/gifts/gift-object#claim_expiry_date)
                    .
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal comment for this action. The comments are not retrievable via API and are only available on request via [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)
                    .
                  maxLength: 250
                  example: null
              required:
              - scheduled_at
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: <p class="mb-2">Resource object representing gift</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                required:
                - gift
                - subscription
                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: []
  /gifts:
    get:
      summary: List gifts
      description: |
        Retrieves the list of gifts.
      operationId: list_gifts
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Status of the gift. Possible values are : scheduled, unclaimed, claimed, cancelled, expired.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "claimed"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: claimed
          properties:
            is:
              type: string
              description: |
                \* \`scheduled\` - Gift has been scheduled. \* \`unclaimed\` - Gift is not yet claimed and is ready to be claimed. \* \`claimed\` - Gift is claimed. \* \`cancelled\` - Gift is cancelled. \* \`expired\` - Gift is expired.
              enum:
              - scheduled
              - unclaimed
              - claimed
              - cancelled
              - expired
              example: null
            is_not:
              type: string
              description: |
                \* \`scheduled\` - Gift has been scheduled. \* \`unclaimed\` - Gift is not yet claimed and is ready to be claimed. \* \`claimed\` - Gift is claimed. \* \`cancelled\` - Gift is cancelled. \* \`expired\` - Gift is expired.
              enum:
              - scheduled
              - unclaimed
              - claimed
              - cancelled
              - expired
              example: null
            in:
              type: string
              description: |
                \* \`scheduled\` - Gift has been scheduled. \* \`unclaimed\` - Gift is not yet claimed and is ready to be claimed. \* \`claimed\` - Gift is claimed. \* \`cancelled\` - Gift is cancelled. \* \`expired\` - Gift is expired.
              enum:
              - scheduled
              - unclaimed
              - claimed
              - cancelled
              - expired
              pattern: "^\\[(scheduled|unclaimed|claimed|cancelled|expired)(,(scheduled|unclaimed|claimed|cancelled|expired))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`scheduled\` - Gift has been scheduled. \* \`unclaimed\` - Gift is not yet claimed and is ready to be claimed. \* \`claimed\` - Gift is claimed. \* \`cancelled\` - Gift is cancelled. \* \`expired\` - Gift is expired.
              enum:
              - scheduled
              - unclaimed
              - claimed
              - cancelled
              - expired
              pattern: "^\\[(scheduled|unclaimed|claimed|cancelled|expired)(,(scheduled|unclaimed|claimed|cancelled|expired))*\\\
                ]$"
              example: null
      - name: gift_receiver
        in: query
        description: |
          Parameters for gift_receiver
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            email:
              type: object
              deprecated: false
              description: |
                Email of the receiver. All gift related emails are sent to this email.
              example: john@test.com
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
            customer_id:
              type: object
              deprecated: false
              description: |
                Receiver customer id.
              example: 1xRt6ifdr
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
          example: null
      - name: gifter
        in: query
        description: |
          Parameters for gifter
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            customer_id:
              type: object
              deprecated: false
              description: |
                Gifter customer id.
              example: 1xRt6ifdr
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        gift:
                          $ref: "#/components/schemas/Gift"
                          description: Resource object representing gift
                        subscription:
                          $ref: "#/components/schemas/Subscription"
                          description: Resource object representing subscription
                      required:
                      - gift
                      - subscription
                      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: []
    post:
      summary: Create a gift
      description: |
        **Note:**
        This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)
        and pass it as input parameter to this API.

        Creates a gift subscription with the gifter and receiver. Only plans marked as gift plans can be used to create gift subscription. It may also have addons and coupons. A gift is initially created in '**scheduled** ' state and the gift subscription will be created in '**future**' state and invoiced immediately.

        Term start and term end dates are determined based on whether the gift is claimed. Before claim, term start date is the subscription start date. Term end date occurs at the end of the plan's frequency. Once the gift is claimed, the gift claim date becomes the term start date and the term end date will be set as the end of the plan's frequency.
      operationId: create_a_gift
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
                  example: null
                auto_claim:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , the claim happens automatically. When not passed, the default value in the site settings is used.</p>
                  example: null
                no_expiry:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , indicates that the gift does not expire. Do not pass or pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
                    is set.
                    .</p>
                  example: null
                claim_expiry_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The date until which the gift can be claimed. Must be set to a value after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheduled_at</code>.
                    If the gift is not claimed within <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">claim_expiry_date</code>
                    , it will expire and the subscription will move to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    state. When not passed, the value specified in the site settings will be used.
                    Pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NULL</code>
                    or do not pass when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">no_expiry</code>
                    are set.</p>
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                gifter:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gifter
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Gifter customer id.
                      maxLength: 50
                      example: null
                    signature:
                      type: string
                      deprecated: false
                      description: |
                        Gifter sign-off name
                      maxLength: 50
                      example: null
                    note:
                      type: string
                      deprecated: false
                      description: |
                        Personalized message for the gift.
                      maxLength: 500
                      example: null
                    payment_src_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the payment source
                      maxLength: 40
                      example: null
                  required:
                  - customer_id
                  - signature
                  example: null
                gift_receiver:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gift_receiver
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Receiver customer id.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the receiver as given by the gifter.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the receiver as given by the gifter,
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the receiver. All gift related emails are sent to this email.
                      maxLength: 70
                      example: null
                  required:
                  - customer_id
                  - email
                  - first_name
                  - last_name
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* payme -

                        Payments made via PayMe
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* go_pay -

                        Payments made via GoPay
                        \* pay_by_bank -

                        Pay By Bank
                        \* google_pay -

                        google_pay
                        \* apple_pay -

                        apple_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* giropay -

                        giropay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* ideal -

                        ideal
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        Plan Quantity for this subscription in Multi Decimal
                      maxLength: 33
                      example: null
                  required:
                  - plan_id
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              gift_receiver:
                style: deepObject
                explode: true
              gifter:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: <p class="mb-2">Resource object representing gift</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                required:
                - gift
                - subscription
                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: []
  /gifts/{gift-id}:
    get:
      summary: Retrieve a gift
      description: |
        Retrieves a gift subscription. This API accepts the gift 'id' and returns the gift along with the subscription.
      operationId: retrieve_a_gift
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: gift-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/gift-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: <p class="mb-2">Resource object representing gift</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                required:
                - gift
                - subscription
                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: []
  /gifts/{gift-id}/claim:
    post:
      summary: Claim a gift
      description: |
        Claiming a gift will move the status to 'claimed'. Only gifts in 'unclaimed' state can be claimed.
      operationId: claim_a_gift
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: gift-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/gift-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: <p class="mb-2">Resource object representing gift</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                required:
                - gift
                - subscription
                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: []
  /transactions:
    get:
      summary: List transactions
      description: |
        Lists all the transactions.
      operationId: list_transactions
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\*\\\\\\\*deleted\\\\\\\*\\\\\\\* ' attribute will be '\\\\\\\*\\\\\\\*true\\\\\\\*\\\\\\\* '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Uniquely identifies the transaction.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "txn_88ybdbsnvf2"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: txn_88ybdbsnvf2
          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: customer_id
        in: query
        description: |
          optional, string filter

          Identifier of the customer for which this transaction is made.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *customer_id\[is\] = "5hjdk8nOpd"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 5hjdk8nOpd
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: subscription_id
        in: query
        description: |
          optional, string filter

          Identifier of the subscription for which this transaction is made.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *subscription_id\[is\] = "5hjdk8nOpd"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 5hjdk8nOpd
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: payment_source_id
        in: query
        description: |
          optional, string filter

          To filter based on Transaction payment source id.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *payment_source_id\[is\] = "pm_3Nl8XXUQUXDVFa2"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: pm_3Nl8XXUQUXDVFa2
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: payment_method
        in: query
        description: |
          optional, enumerated string filter

          The payment method of this transaction. Possible values are : card, cash, check, chargeback, bank_transfer, amazon_payments, paypal_express_checkout, direct_debit, alipay, unionpay, apple_pay, wechat_pay, ach_credit, sepa_credit, ideal, google_pay, sofort, bancontact, giropay, dotpay, other, upi, netbanking_emandates.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *payment_method\[is\] = "card"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: card
          properties:
            is:
              type: string
              description: |-
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                * `ach_credit` - ACH Credit
                * `sepa_credit` - SEPA Credit
                * `ideal` - IDEAL
                * `google_pay` - Google Pay
                * `sofort` - Sofort
                * `bancontact` - Bancontact
                * `giropay` - giropay
                * `dotpay` - Dotpay
                * `other` - Payment Methods other than the above types
                * `app_store` - **(Deprecated)** App Store
                * `upi` - upi
                * `netbanking_emandates` - netbanking_emandates
                * `play_store` - **(Deprecated)** Play Store
                * `custom` - Custom
                * `boleto` - boleto
                * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                * `kbc_payment_button` - Payments made via KBC Payment Button.
                * `pay_by_bank` - Payments made via Pay By Bank.
                * `trustly` - Payments made via Trustly.
                * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
              enum:
              - card
              - cash
              - check
              - chargeback
              - bank_transfer
              - amazon_payments
              - paypal_express_checkout
              - direct_debit
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ach_credit
              - sepa_credit
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - other
              - upi
              - netbanking_emandates
              - custom
              - boleto
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - pix
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - klarna
              example: null
            is_not:
              type: string
              description: |-
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                * `ach_credit` - ACH Credit
                * `sepa_credit` - SEPA Credit
                * `ideal` - IDEAL
                * `google_pay` - Google Pay
                * `sofort` - Sofort
                * `bancontact` - Bancontact
                * `giropay` - giropay
                * `dotpay` - Dotpay
                * `other` - Payment Methods other than the above types
                * `app_store` - **(Deprecated)** App Store
                * `upi` - upi
                * `netbanking_emandates` - netbanking_emandates
                * `play_store` - **(Deprecated)** Play Store
                * `custom` - Custom
                * `boleto` - boleto
                * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                * `kbc_payment_button` - Payments made via KBC Payment Button.
                * `pay_by_bank` - Payments made via Pay By Bank.
                * `trustly` - Payments made via Trustly.
                * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
              enum:
              - card
              - cash
              - check
              - chargeback
              - bank_transfer
              - amazon_payments
              - paypal_express_checkout
              - direct_debit
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ach_credit
              - sepa_credit
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - other
              - upi
              - netbanking_emandates
              - custom
              - boleto
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - pix
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - klarna
              example: null
            in:
              type: string
              description: |-
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                * `ach_credit` - ACH Credit
                * `sepa_credit` - SEPA Credit
                * `ideal` - IDEAL
                * `google_pay` - Google Pay
                * `sofort` - Sofort
                * `bancontact` - Bancontact
                * `giropay` - giropay
                * `dotpay` - Dotpay
                * `other` - Payment Methods other than the above types
                * `app_store` - **(Deprecated)** App Store
                * `upi` - upi
                * `netbanking_emandates` - netbanking_emandates
                * `play_store` - **(Deprecated)** Play Store
                * `custom` - Custom
                * `boleto` - boleto
                * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                * `kbc_payment_button` - Payments made via KBC Payment Button.
                * `pay_by_bank` - Payments made via Pay By Bank.
                * `trustly` - Payments made via Trustly.
                * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
              enum:
              - card
              - cash
              - check
              - chargeback
              - bank_transfer
              - amazon_payments
              - paypal_express_checkout
              - direct_debit
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ach_credit
              - sepa_credit
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - other
              - upi
              - netbanking_emandates
              - custom
              - boleto
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - pix
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - klarna
              pattern: "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                * `ach_credit` - ACH Credit
                * `sepa_credit` - SEPA Credit
                * `ideal` - IDEAL
                * `google_pay` - Google Pay
                * `sofort` - Sofort
                * `bancontact` - Bancontact
                * `giropay` - giropay
                * `dotpay` - Dotpay
                * `other` - Payment Methods other than the above types
                * `app_store` - **(Deprecated)** App Store
                * `upi` - upi
                * `netbanking_emandates` - netbanking_emandates
                * `play_store` - **(Deprecated)** Play Store
                * `custom` - Custom
                * `boleto` - boleto
                * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                * `kbc_payment_button` - Payments made via KBC Payment Button.
                * `pay_by_bank` - Payments made via Pay By Bank.
                * `trustly` - Payments made via Trustly.
                * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
              enum:
              - card
              - cash
              - check
              - chargeback
              - bank_transfer
              - amazon_payments
              - paypal_express_checkout
              - direct_debit
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ach_credit
              - sepa_credit
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - other
              - upi
              - netbanking_emandates
              - custom
              - boleto
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - pix
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - klarna
              pattern: "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\\
                ]$"
              example: null
      - name: gateway
        in: query
        description: |
          optional, enumerated string filter

          Gateway through which this transaction was done. Applicable only for 'Card' Payment Method. Possible values are : chargebee, chargebee_payments, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, adyen, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, not_applicable.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *gateway\[is_not\] = "stripe"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: stripe
          properties:
            is:
              type: string
              description: |-
                * `chargebee` - Chargebee test gateway.
                * `chargebee_payments` - Chargebee Payments gateway
                * `adyen` - Adyen is a payment gateway.
                * `stripe` - Stripe is a payment gateway.
                * `wepay` - WePay is a payment gateway.
                * `braintree` - Braintree is a payment gateway.
                * `authorize_net` - Authorize.net is a payment gateway
                * `paypal_pro` - PayPal Pro Account is a payment gateway.
                * `pin` - Pin is a payment gateway
                * `eway` - eWAY Account is a payment gateway.
                * `eway_rapid` - eWAY Rapid is a payment gateway.
                * `worldpay` - WorldPay is a payment gateway
                * `balanced_payments` - Balanced is a payment gateway
                * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                * `bluepay` - BluePay is a payment gateway.
                * `elavon` - Elavon Virtual Merchant is a payment solution.
                * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                * `hdfc` - HDFC Account is a payment gateway.
                * `migs` - MasterCard Internet Gateway Service payment gateway.
                * `nmi` - NMI is a payment gateway.
                * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                * `paymill` - PAYMILL is a payment gateway.
                * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                * `sage_pay` - Sage Pay is a payment gateway.
                * `tco` - 2Checkout is a payment gateway.
                * `wirecard` - WireCard Account is a payment service provider.
                * `amazon_payments` - Amazon Payments is a payment service provider.
                * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                * `gocardless` - GoCardless is a payment service provider.
                * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                * `moneris_us` - Moneris USA is a payment gateway.
                * `moneris` - Moneris is a payment gateway.
                * `bluesnap` - BlueSnap is a payment gateway.
                * `cybersource` - CyberSource is a payment gateway.
                * `vantiv` - Vantiv is a payment gateway.
                * `checkout_com` - Checkout.com is a payment gateway.
                * `paypal` - PayPal Commerce is a payment gateway.
                * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                * `exact` - Exact Payments is a payment gateway.
                * `mollie` - Mollie is a payment gateway.
                * `quickbooks` - Intuit QuickBooks Payments gateway
                * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                * `global_payments` - Global Payments is a payment service provider.
                * `bank_of_america` - Bank of America Gateway
                * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
              enum:
              - chargebee
              - chargebee_payments
              - adyen
              - stripe
              - wepay
              - braintree
              - authorize_net
              - paypal_pro
              - pin
              - eway
              - eway_rapid
              - worldpay
              - balanced_payments
              - beanstream
              - bluepay
              - elavon
              - first_data_global
              - hdfc
              - migs
              - nmi
              - ogone
              - paymill
              - paypal_payflow_pro
              - sage_pay
              - tco
              - wirecard
              - amazon_payments
              - paypal_express_checkout
              - gocardless
              - orbital
              - moneris_us
              - moneris
              - bluesnap
              - cybersource
              - vantiv
              - checkout_com
              - paypal
              - ingenico_direct
              - exact
              - mollie
              - quickbooks
              - razorpay
              - global_payments
              - bank_of_america
              - ecentric
              - metrics_global
              - windcave
              - pay_com
              - ebanx
              - dlocal
              - nuvei
              - solidgate
              - paystack
              - jp_morgan
              - deutsche_bank
              - ezidebit
              - twikey
              - tempus
              - moyasar
              - payway
              - not_applicable
              example: null
            is_not:
              type: string
              description: |-
                * `chargebee` - Chargebee test gateway.
                * `chargebee_payments` - Chargebee Payments gateway
                * `adyen` - Adyen is a payment gateway.
                * `stripe` - Stripe is a payment gateway.
                * `wepay` - WePay is a payment gateway.
                * `braintree` - Braintree is a payment gateway.
                * `authorize_net` - Authorize.net is a payment gateway
                * `paypal_pro` - PayPal Pro Account is a payment gateway.
                * `pin` - Pin is a payment gateway
                * `eway` - eWAY Account is a payment gateway.
                * `eway_rapid` - eWAY Rapid is a payment gateway.
                * `worldpay` - WorldPay is a payment gateway
                * `balanced_payments` - Balanced is a payment gateway
                * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                * `bluepay` - BluePay is a payment gateway.
                * `elavon` - Elavon Virtual Merchant is a payment solution.
                * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                * `hdfc` - HDFC Account is a payment gateway.
                * `migs` - MasterCard Internet Gateway Service payment gateway.
                * `nmi` - NMI is a payment gateway.
                * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                * `paymill` - PAYMILL is a payment gateway.
                * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                * `sage_pay` - Sage Pay is a payment gateway.
                * `tco` - 2Checkout is a payment gateway.
                * `wirecard` - WireCard Account is a payment service provider.
                * `amazon_payments` - Amazon Payments is a payment service provider.
                * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                * `gocardless` - GoCardless is a payment service provider.
                * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                * `moneris_us` - Moneris USA is a payment gateway.
                * `moneris` - Moneris is a payment gateway.
                * `bluesnap` - BlueSnap is a payment gateway.
                * `cybersource` - CyberSource is a payment gateway.
                * `vantiv` - Vantiv is a payment gateway.
                * `checkout_com` - Checkout.com is a payment gateway.
                * `paypal` - PayPal Commerce is a payment gateway.
                * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                * `exact` - Exact Payments is a payment gateway.
                * `mollie` - Mollie is a payment gateway.
                * `quickbooks` - Intuit QuickBooks Payments gateway
                * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                * `global_payments` - Global Payments is a payment service provider.
                * `bank_of_america` - Bank of America Gateway
                * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
              enum:
              - chargebee
              - chargebee_payments
              - adyen
              - stripe
              - wepay
              - braintree
              - authorize_net
              - paypal_pro
              - pin
              - eway
              - eway_rapid
              - worldpay
              - balanced_payments
              - beanstream
              - bluepay
              - elavon
              - first_data_global
              - hdfc
              - migs
              - nmi
              - ogone
              - paymill
              - paypal_payflow_pro
              - sage_pay
              - tco
              - wirecard
              - amazon_payments
              - paypal_express_checkout
              - gocardless
              - orbital
              - moneris_us
              - moneris
              - bluesnap
              - cybersource
              - vantiv
              - checkout_com
              - paypal
              - ingenico_direct
              - exact
              - mollie
              - quickbooks
              - razorpay
              - global_payments
              - bank_of_america
              - ecentric
              - metrics_global
              - windcave
              - pay_com
              - ebanx
              - dlocal
              - nuvei
              - solidgate
              - paystack
              - jp_morgan
              - deutsche_bank
              - ezidebit
              - twikey
              - tempus
              - moyasar
              - payway
              - not_applicable
              example: null
            in:
              type: string
              description: |-
                * `chargebee` - Chargebee test gateway.
                * `chargebee_payments` - Chargebee Payments gateway
                * `adyen` - Adyen is a payment gateway.
                * `stripe` - Stripe is a payment gateway.
                * `wepay` - WePay is a payment gateway.
                * `braintree` - Braintree is a payment gateway.
                * `authorize_net` - Authorize.net is a payment gateway
                * `paypal_pro` - PayPal Pro Account is a payment gateway.
                * `pin` - Pin is a payment gateway
                * `eway` - eWAY Account is a payment gateway.
                * `eway_rapid` - eWAY Rapid is a payment gateway.
                * `worldpay` - WorldPay is a payment gateway
                * `balanced_payments` - Balanced is a payment gateway
                * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                * `bluepay` - BluePay is a payment gateway.
                * `elavon` - Elavon Virtual Merchant is a payment solution.
                * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                * `hdfc` - HDFC Account is a payment gateway.
                * `migs` - MasterCard Internet Gateway Service payment gateway.
                * `nmi` - NMI is a payment gateway.
                * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                * `paymill` - PAYMILL is a payment gateway.
                * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                * `sage_pay` - Sage Pay is a payment gateway.
                * `tco` - 2Checkout is a payment gateway.
                * `wirecard` - WireCard Account is a payment service provider.
                * `amazon_payments` - Amazon Payments is a payment service provider.
                * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                * `gocardless` - GoCardless is a payment service provider.
                * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                * `moneris_us` - Moneris USA is a payment gateway.
                * `moneris` - Moneris is a payment gateway.
                * `bluesnap` - BlueSnap is a payment gateway.
                * `cybersource` - CyberSource is a payment gateway.
                * `vantiv` - Vantiv is a payment gateway.
                * `checkout_com` - Checkout.com is a payment gateway.
                * `paypal` - PayPal Commerce is a payment gateway.
                * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                * `exact` - Exact Payments is a payment gateway.
                * `mollie` - Mollie is a payment gateway.
                * `quickbooks` - Intuit QuickBooks Payments gateway
                * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                * `global_payments` - Global Payments is a payment service provider.
                * `bank_of_america` - Bank of America Gateway
                * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
              enum:
              - chargebee
              - chargebee_payments
              - adyen
              - stripe
              - wepay
              - braintree
              - authorize_net
              - paypal_pro
              - pin
              - eway
              - eway_rapid
              - worldpay
              - balanced_payments
              - beanstream
              - bluepay
              - elavon
              - first_data_global
              - hdfc
              - migs
              - nmi
              - ogone
              - paymill
              - paypal_payflow_pro
              - sage_pay
              - tco
              - wirecard
              - amazon_payments
              - paypal_express_checkout
              - gocardless
              - orbital
              - moneris_us
              - moneris
              - bluesnap
              - cybersource
              - vantiv
              - checkout_com
              - paypal
              - ingenico_direct
              - exact
              - mollie
              - quickbooks
              - razorpay
              - global_payments
              - bank_of_america
              - ecentric
              - metrics_global
              - windcave
              - pay_com
              - ebanx
              - dlocal
              - nuvei
              - solidgate
              - paystack
              - jp_morgan
              - deutsche_bank
              - ezidebit
              - twikey
              - tempus
              - moyasar
              - payway
              - not_applicable
              pattern: "^\\[(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable)(,(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `chargebee` - Chargebee test gateway.
                * `chargebee_payments` - Chargebee Payments gateway
                * `adyen` - Adyen is a payment gateway.
                * `stripe` - Stripe is a payment gateway.
                * `wepay` - WePay is a payment gateway.
                * `braintree` - Braintree is a payment gateway.
                * `authorize_net` - Authorize.net is a payment gateway
                * `paypal_pro` - PayPal Pro Account is a payment gateway.
                * `pin` - Pin is a payment gateway
                * `eway` - eWAY Account is a payment gateway.
                * `eway_rapid` - eWAY Rapid is a payment gateway.
                * `worldpay` - WorldPay is a payment gateway
                * `balanced_payments` - Balanced is a payment gateway
                * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                * `bluepay` - BluePay is a payment gateway.
                * `elavon` - Elavon Virtual Merchant is a payment solution.
                * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                * `hdfc` - HDFC Account is a payment gateway.
                * `migs` - MasterCard Internet Gateway Service payment gateway.
                * `nmi` - NMI is a payment gateway.
                * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                * `paymill` - PAYMILL is a payment gateway.
                * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                * `sage_pay` - Sage Pay is a payment gateway.
                * `tco` - 2Checkout is a payment gateway.
                * `wirecard` - WireCard Account is a payment service provider.
                * `amazon_payments` - Amazon Payments is a payment service provider.
                * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                * `gocardless` - GoCardless is a payment service provider.
                * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                * `moneris_us` - Moneris USA is a payment gateway.
                * `moneris` - Moneris is a payment gateway.
                * `bluesnap` - BlueSnap is a payment gateway.
                * `cybersource` - CyberSource is a payment gateway.
                * `vantiv` - Vantiv is a payment gateway.
                * `checkout_com` - Checkout.com is a payment gateway.
                * `paypal` - PayPal Commerce is a payment gateway.
                * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                * `exact` - Exact Payments is a payment gateway.
                * `mollie` - Mollie is a payment gateway.
                * `quickbooks` - Intuit QuickBooks Payments gateway
                * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                * `global_payments` - Global Payments is a payment service provider.
                * `bank_of_america` - Bank of America Gateway
                * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
              enum:
              - chargebee
              - chargebee_payments
              - adyen
              - stripe
              - wepay
              - braintree
              - authorize_net
              - paypal_pro
              - pin
              - eway
              - eway_rapid
              - worldpay
              - balanced_payments
              - beanstream
              - bluepay
              - elavon
              - first_data_global
              - hdfc
              - migs
              - nmi
              - ogone
              - paymill
              - paypal_payflow_pro
              - sage_pay
              - tco
              - wirecard
              - amazon_payments
              - paypal_express_checkout
              - gocardless
              - orbital
              - moneris_us
              - moneris
              - bluesnap
              - cybersource
              - vantiv
              - checkout_com
              - paypal
              - ingenico_direct
              - exact
              - mollie
              - quickbooks
              - razorpay
              - global_payments
              - bank_of_america
              - ecentric
              - metrics_global
              - windcave
              - pay_com
              - ebanx
              - dlocal
              - nuvei
              - solidgate
              - paystack
              - jp_morgan
              - deutsche_bank
              - ezidebit
              - twikey
              - tempus
              - moyasar
              - payway
              - not_applicable
              pattern: "^\\[(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable)(,(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable))*\\\
                ]$"
              example: null
      - name: gateway_account_id
        in: query
        description: |
          optional, string filter

          The gateway account used for this transaction.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *gateway_account_id\[is\] = "gw_3Nl9BNeQ7438Ks1"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: gw_3Nl9BNeQ7438Ks1
          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_at_gateway
        in: query
        description: |
          optional, string filter

          The id with which this transaction is referred in gateway.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *id_at_gateway\[is_not\] = "txn_5678HJS89900"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: txn_5678HJS89900
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: reference_number
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn>
          <p class="mb-2">The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code>
          = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
          .
          <strong class="font-semibold">Supported operators :</strong>
          is, is_not, starts_with, is_present</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">reference_number[is] = &quot;cus_u239732&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: cus_u239732
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: type
        in: query
        description: |
          optional, enumerated string filter

          Type of the transaction. Possible values are : authorization, payment, refund, payment_reversal.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *type\[is\] = "payment"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: payment
          properties:
            is:
              type: string
              description: |-
                * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment_reversal` - Indicates a reversal transaction.
              enum:
              - authorization
              - payment
              - refund
              - payment_reversal
              example: null
            is_not:
              type: string
              description: |-
                * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment_reversal` - Indicates a reversal transaction.
              enum:
              - authorization
              - payment
              - refund
              - payment_reversal
              example: null
            in:
              type: string
              description: |-
                * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment_reversal` - Indicates a reversal transaction.
              enum:
              - authorization
              - payment
              - refund
              - payment_reversal
              pattern: "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                * `payment_reversal` - Indicates a reversal transaction.
              enum:
              - authorization
              - payment
              - refund
              - payment_reversal
              pattern: "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\\
                ]$"
              example: null
      - name: date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Indicates when this transaction occurred.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *date\[before\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: amount
        in: query
        description: |
          optional, in cents filter

          Amount for this transaction.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount\[is\] = "1200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: amount_capturable
        in: query
        description: |
          optional, in cents filter

          To filter based on transaction's unused authorized/blocked amount.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_capturable\[gte\] = "1200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          The status of this transaction. Possible values are : in_progress, success, voided, failure, timeout, needs_attention.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is_not\] = "success"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: success
          properties:
            is:
              type: string
              description: |
                \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
              enum:
              - in_progress
              - success
              - voided
              - failure
              - timeout
              - needs_attention
              - late_failure
              example: null
            is_not:
              type: string
              description: |
                \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
              enum:
              - in_progress
              - success
              - voided
              - failure
              - timeout
              - needs_attention
              - late_failure
              example: null
            in:
              type: string
              description: |
                \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
              enum:
              - in_progress
              - success
              - voided
              - failure
              - timeout
              - needs_attention
              - late_failure
              pattern: "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
              enum:
              - in_progress
              - success
              - voided
              - failure
              - timeout
              - needs_attention
              - late_failure
              pattern: "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn>
          <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
          This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
          input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
          for a faster response.
          <strong class="font-semibold">Supported operators :</strong>
          after, before, on, between</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">updated_at[before] = &quot;1243545465&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - date
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        transaction:
                          $ref: "#/components/schemas/Transaction"
                          description: <p class="mb-2">Resource object representing
                            transaction</p>
                      required:
                      - transaction
                      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: []
  /transactions/{transaction-id}/reconcile:
    post:
      summary: Reconcile transaction
      description: "<div class=\"api-description\"><p class=\"mb-2\">Update selected\
        \ attributes of the transaction resource: <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">status</code>, <code class=\"bg-gray-100 text-gray-800\
        \ font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono\
        \ whitespace-nowrap\">id_at_gateway</code>, and <code class=\"bg-gray-100\
        \ text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1\
        \ text-sm font-mono whitespace-nowrap\">customer_id</code>. Use this API for\
        \ reconciliation purposes where the status of a transaction is in <code><a\
        \ href=\"/docs/api/v2/pcv-1/transactions/transaction-object#status\">needs_attention</a></code>\
        \ that can be updated to either <code><a href=\"/docs/api/v2/pcv-1/transactions/transaction-object#status\"\
        \ rel=\"noopener noreferrer\">success</a></code> or <code><a href=\"/docs/api/v2/pcv-1/transactions/transaction-object#status\"\
        >failure</a></code> status.</p></div>"
      operationId: reconcile_transaction
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id_at_gateway:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The identifier with which this transaction is referred in gateway. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                    can only be updated when the transaction status is in <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#status">needs_attention</a></code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">It is mandatory to pass this parameter value for updating the transaction status from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>. It is recommended to pass this value if available in the gateway.</li>
                    <li class="text-base leading-relaxed">An error occurs when the provided <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code> value does not match the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code> value stored against the transaction in Chargebee.</li>
                    </ul></div>
                  maxLength: 100
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Unique identifier of the customer for which this transaction is made. This is needed only when the transaction is successful but not associated with any customer.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><p class="mb-2">An error occurs when the provided <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
                    value does not match the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
                    value stored against the transaction in Chargebee.</p></div>
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The status of this transaction. The status can only be updated when the transaction status is in <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#status">needs_attention</a></code>
                    .</p>
                    * failure - <p class="mb-2">When the transaction is in failure status.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><p class="mb-2">When the transaction is updated to <code><a href="/docs/api/transactions/transaction-object#status">failure</a></code> status and the invoice is associated with the transaction,</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">the invoice will be moved to the <code><a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">payment_due</a></code> status if the <code><a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html">dunning</a></code> is configured.</li>
                    <li class="text-base leading-relaxed">the invoice will be moved to the <code><a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">not_paid</a></code> status if the <code><a href="https://www.chargebee.com/docs/payments/1.0/dunning-v2.html">dunning</a></code> is not configured.</li>
                    </ul></div>
                    * success - <p class="mb-2">When the transaction is successful.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><p class="mb-2">When the transaction is updated to <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#status">success</a></code>
                    status, -   and the invoice is associated with the transaction, the transaction <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#amount">amount</a></code> will be applied to the invoice.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">and no invoice is associated but the customer is associated with the transaction, <code><a href="/docs/api/v2/pcv-1/customers/customer-object#excess_payments">customer_excess_payments</a></code> will be updated.</li>
                    </ul></div>
                  enum:
                  - success
                  - failure
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /transactions/{transaction-id}:
    get:
      summary: Retrieve a transaction
      description: |
        Retrieve a transaction identified by its unique id.
      operationId: retrieve_a_transaction
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /transactions/{transaction-id}/refund:
    post:
      summary: Refund a payment
      description: |-
        <div class="api-description"><p class="mb-2">Refunds an online payment. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction</code>s of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>. You can only refund a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction</code> whose <code><a href="/docs/api/transactions/transaction-object#status">status</a></code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</p><div class="alert alert-info"><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Not supported for ach_credit, sepa_credit, cash, check, bank_transfer, other.</li>
        <li class="text-base leading-relaxed">Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this endpoint.</li>
        </ul></div></div>
      operationId: refund_a_payment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount to be refunded. Must not exceed <code><a href="/docs/api/transactions/transaction-object#amount_unused">amount_unused</a></code>.
                    If not passed then all of <code><a href="/docs/api/transactions/transaction-object#amount_unused">amount_unused</a></code>
                    is refunded.</p>
                  minimum: 1
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the refund.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /transactions/{transaction-id}/record_refund:
    post:
      summary: Record an offline refund
      description: <div class="api-description"><p class="mb-2">Records a refund made
        offline. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium
        border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction</code>s
        of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300
        rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>.</p></div>
      operationId: record_an_offline_refund
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount to be recorded as refunded. Must not exceed <code><a href="/docs/api/transactions/transaction-object#amount_unused">amount_unused</a></code>.
                    If not passed then all of <code><a href="/docs/api/transactions/transaction-object#amount_unused">amount_unused</a></code>
                    is recorded as refunded.</p>
                  minimum: 1
                  example: null
                payment_method:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The payment method used to make the refund.</p>
                    * card - <p class="mb-2">Card</p>
                    * custom - <p class="mb-2">Custom</p>
                    * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
                    <span featureId="cb-naver-pay" isMicro="true"></span>
                    * venmo - <p class="mb-2">Venmo</p>
                    <span featureId="cb-venmo" isMicro="true"></span>
                    * amazon_payments - <p class="mb-2">Amazon Payments</p>
                    * ideal - <p class="mb-2">IDEAL</p>
                    * boleto - <p class="mb-2">boleto</p>
                    * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
                    = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
                    This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
                    occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
                    .</p>
                    * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
                    <span featureId="cb-bank-transfer" isMicro="true"></span>
                    * google_pay - <p class="mb-2">Google Pay</p>
                    * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
                    * unionpay - <p class="mb-2">Unionpay</p>
                    * pay_to - <p class="mb-2">PayTo</p>
                    <span featureId="cb-pay-to" isMicro="true"></span>
                    * bank_transfer - <p class="mb-2">Bank Transfer</p>
                    * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
                    * pay_by_bank - <p class="mb-2">Pay By Bank</p>
                    * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
                    * direct_debit - <p class="mb-2">Direct Debit</p>
                    * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
                    <span featureId="cb-klarna-pay-now" isMicro="true"></span>
                    * dotpay - <p class="mb-2">Dotpay</p>
                    * other - <p class="mb-2">Payment Methods other than the above types</p>
                    * alipay - <p class="mb-2">Payments made via Alipay.</p>
                    <span featureId="cb-alipay" isMicro="true"></span>
                    * sofort - <p class="mb-2">Sofort</p>
                    * play_store - <p class="mb-2">Play Store</p>
                    * swish - <p class="mb-2">Payments made via Swish</p>
                    <span featureId="cb-swish" isMicro="true"></span>
                    * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
                    <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
                    * upi - <p class="mb-2">upi</p>
                    * trustly - <p class="mb-2">Trustly</p>
                    * ach_credit - <p class="mb-2">ACH Credit</p>
                    * apple_pay - <p class="mb-2">Apple Pay</p>
                    * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
                    <span featureId="cb-grab-pay" isMicro="true"></span>
                    * pix - <p class="mb-2">Pix</p>
                    <span featureId="cb-pix" isMicro="true"></span>
                    * giropay - <p class="mb-2">giropay</p>
                    * pay_co - <p class="mb-2">Payments made via PayCo</p>
                    <span featureId="cb-pay-co" isMicro="true"></span>
                    * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
                    <span featureId="cb-wechat-pay" isMicro="true"></span>
                    * sepa_credit - <p class="mb-2">SEPA Credit</p>
                    * twint - <p class="mb-2">Payments made via Twint</p>
                    <span featureId="cb-twint" isMicro="true"></span>
                    * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
                    <span featureId="cb-revolut-pay" isMicro="true"></span>
                    * cash - <p class="mb-2">Cash</p>
                    * after_pay - <p class="mb-2">Payments made via Afterpay</p>
                    <span featureId="cb-after-pay" isMicro="true"></span>
                    * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
                    * bancontact - <p class="mb-2">Bancontact</p>
                    * faster_payments - <p class="mb-2">Faster Payments</p>
                    <span featureId="cb-faster-payments" isMicro="true"></span>
                    * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
                    <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
                    * go_pay - <p class="mb-2">Payments made via GoPay</p>
                    <span featureId="cb-go-pay" isMicro="true"></span>
                    * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
                    <span featureId="cb-kakao-pay" isMicro="true"></span>
                    * app_store - <p class="mb-2">App Store</p>
                    * check - <p class="mb-2">Check</p>
                    * payme - <p class="mb-2">Payments made via PayMe</p>
                    <span featureId="cb-payme" isMicro="true"></span>
                    * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
                    <span featureId="cb-stablecoin" isMicro="true"></span>
                    * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
                    <span featureId="cb-cash-app-pay" isMicro="true"></span>
                  enum:
                  - cash
                  - check
                  - chargeback
                  - bank_transfer
                  - other
                  - custom
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date when the refund was made.
                  example: null
                reference_number:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The reference number for this transaction. For example, the check number when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method</code>
                    = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                    .</p>
                  maxLength: 100
                  example: null
                custom_payment_method_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the custom payment method of this transaction.
                  maxLength: 50
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Remarks, if any, on the refund.
                  maxLength: 300
                  example: null
              required:
              - date
              - payment_method
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /transactions/{transaction-id}/void:
    post:
      summary: Void an authorization transaction
      description: |
        This API voids the specific authorization transaction in order to release the blocked funds from the customer's card. Voiding an already captured or voided transaction is not possible.
      operationId: void_an_authorization_transaction
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /transactions/create_authorization:
    post:
      summary: Create an authorization payment
      description: "Authorizes a specific amount in customer's Credit card, which\
        \ can be collected within a span of time. Read more on authorization and capture\
        \ [here](https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/stripe#auth-and-capture).\
        \  \n* Supported only for Card payments.\n* Currently supported only for **Stripe**.\n"
      operationId: create_an_authorization_payment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer.
                  maxLength: 50
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for authorizing the transaction.
                  maxLength: 40
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the transaction amount.
                  maxLength: 3
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The amount to be blocked.
                  minimum: 1
                  example: null
              required:
              - amount
              - customer_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /invoices/{invoice-id}/payments:
    get:
      summary: List payments for an invoice
      description: |
        Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \& automatic) made for this invoice.
      operationId: list_payments_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        transaction:
                          $ref: "#/components/schemas/Transaction"
                          description: <p class="mb-2">Resource object representing
                            transaction</p>
                      required:
                      - transaction
                      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: []
  /transactions/{transaction-id}/delete_offline_transaction:
    post:
      summary: Delete an offline transaction
      description: |
        This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.
      operationId: delete_an_offline_transaction
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: transaction-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/transaction-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: <p class="mb-2">Resource object representing transaction</p>
                required:
                - transaction
                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: []
  /hosted_pages/update_payment_method:
    post:
      summary: Update payment method
      description: |
        **Note:** If you're using [In-App Checkout](https://www.chargebee.com/docs/2.0/checkout.html) , use [Manage Payment Sources API](/docs/api/hosted_pages/manage-payment-sources) to request your customers to update their payment method details or change their payment method.

        Using this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.

        When this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.

        Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment.
        **Note:**

        * If the card\[gateway\] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card\[gateway\] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.
        * The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed=true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed=true, the returned hosted page URL will show only Card Payment as a payment method.
      operationId: update_payment_method
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
                    Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code>
                    after successful checkout,
                    we do not recommend relying on it for completing critical post-checkout actions.
                    This is because redirection may not happen due to unforeseen reasons.
                    Chargebee recommends listening to appropriate webhooks such as <code><a href="/docs/api/events">subscription_created</a></code></p>
                    <p class="mb-2">or <code><a href="/docs/api/events">invoice_generated</a></code>
                    to verify a successful checkout.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong>
                    : -   Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.
                    <em class="italic">Eg : http://yoursite.com?id=&amp;state=succeeded</em></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                cancel_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.

                    **Note**
                    : - Cancel URL configured in Settings \> Hosted Pages Settings would be overriden by this cancel URL.
                    *Eg : http://yoursite.com?id=\&state=cancelled*

                    * This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.
                  maxLength: 250
                  example: null
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This attribute allows you to store custom information with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object. You can use it to associate specific data with a hosted page session.
                    For example, you can store the ID of the marketing campaign that initiated the user session. After a successful session, when the customer is redirected, you can retrieve the hosted page ID from the <a href="/docs/api/v2/pcv-1/hosted_pages/update-payment-method#redirect_url">redirect URL</a>&#x27;s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.</p>
                  maxLength: 2048
                  example: null
                embed:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

                    **Note**
                    : For [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout, default is false.
                  example: null
                iframe_messaging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \& onCancel callbacks.

                    **Note**
                    : This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout.
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/extend_subscription:
    post:
      summary: Extend Subscription
      description: |
        This API generates a hosted page URL to extend the billing cycle of a subscription.
      operationId: extend_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                expiry:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Expiry (in days) for the link generated. No expiry will be set if this is not specified.
                  maximum: 500
                  minimum: 1
                  example: null
                billing_cycle:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of billing cycles to extend. If not specified, plan's billing cycle will be used.
                  minimum: 1
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/events:
    post:
      summary: Notify an event
      description: |
        Use this API to notify Chargebee about important events that occur on your web pages, such as subscription cancellations. An event contains data about affected resources and additional details such as when the change occurred.
      operationId: notify_an_event
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event_name:
                  type: string
                  deprecated: false
                  description: |
                    The event that need to passed to a different system.
                    \* cancellation_page_loaded -

                    Indicates native cancellation flow provided by the merchant is loaded rather than the retention flow.
                  enum:
                  - cancellation_page_loaded
                  example: null
                occurred_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Timestamp indicating when this event had occurred.
                    .
                  example: null
                event_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |-
                    <p class="mb-2">The meta data description of the event in key-value pair. The value is a JSON object with the following keys and their values.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code>: A unique and immutable identifier for the subscription.
                    .</li>
                    </ul>
                  example: null
              required:
              - event_data
              - event_name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    deprecated: false
                    example: null
                required:
                - success
                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: []
  /hosted_pages:
    get:
      summary: List hosted pages
      description: |
        This API retrieves the list of hosted page resources.
      operationId: list_hosted_pages
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Unique identifier generated for each hosted page requested.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "Edi69nxpu6BeGBd9Fjcd0tqCSwb0sRcuKa"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Edi69nxpu6BeGBd9Fjcd0tqCSwb0sRcuKa
          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: type
        in: query
        description: |
          optional, enumerated string filter

          Type of the requested hosted page. Possible values are : checkout_new, checkout_existing, update_payment_method, manage_payment_sources, collect_now, extend_subscription, checkout_gift, claim_gift, checkout_one_time, pre_cancel.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *type\[is_not\] = "checkout_new"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: checkout_new
          properties:
            is:
              type: string
              description: |
                \* \`checkout_new\` - Checkout new Subscription \* \`checkout_existing\` - Checkout existing Subscription \* \`update_card\` - \*\*(Deprecated)\*\* Update Card for a Customer \* \`update_payment_method\` - Update Payment Method for a Customer \* \`manage_payment_sources\` - Manage Payments for a customer \* \`collect_now\` - Collect Unpaid Invoices for a Customer \* \`extend_subscription\` - To extend a Subscription period \* \`checkout_gift\` - Checkout a gift subscription \* \`claim_gift\` - Claim a gift subscription \* \`checkout_one_time\` - Checkout one time \* \`pre_cancel\` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription. \* \`view_voucher\` - View Details of a voucher \* \`accept_quote\` - Accept Quote
              enum:
              - checkout_new
              - checkout_existing
              - update_payment_method
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - checkout_gift
              - claim_gift
              - checkout_one_time
              - pre_cancel
              - view_voucher
              - accept_quote
              example: null
            is_not:
              type: string
              description: |
                \* \`checkout_new\` - Checkout new Subscription \* \`checkout_existing\` - Checkout existing Subscription \* \`update_card\` - \*\*(Deprecated)\*\* Update Card for a Customer \* \`update_payment_method\` - Update Payment Method for a Customer \* \`manage_payment_sources\` - Manage Payments for a customer \* \`collect_now\` - Collect Unpaid Invoices for a Customer \* \`extend_subscription\` - To extend a Subscription period \* \`checkout_gift\` - Checkout a gift subscription \* \`claim_gift\` - Claim a gift subscription \* \`checkout_one_time\` - Checkout one time \* \`pre_cancel\` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription. \* \`view_voucher\` - View Details of a voucher \* \`accept_quote\` - Accept Quote
              enum:
              - checkout_new
              - checkout_existing
              - update_payment_method
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - checkout_gift
              - claim_gift
              - checkout_one_time
              - pre_cancel
              - view_voucher
              - accept_quote
              example: null
            in:
              type: string
              description: |
                \* \`checkout_new\` - Checkout new Subscription \* \`checkout_existing\` - Checkout existing Subscription \* \`update_card\` - \*\*(Deprecated)\*\* Update Card for a Customer \* \`update_payment_method\` - Update Payment Method for a Customer \* \`manage_payment_sources\` - Manage Payments for a customer \* \`collect_now\` - Collect Unpaid Invoices for a Customer \* \`extend_subscription\` - To extend a Subscription period \* \`checkout_gift\` - Checkout a gift subscription \* \`claim_gift\` - Claim a gift subscription \* \`checkout_one_time\` - Checkout one time \* \`pre_cancel\` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription. \* \`view_voucher\` - View Details of a voucher \* \`accept_quote\` - Accept Quote
              enum:
              - checkout_new
              - checkout_existing
              - update_payment_method
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - checkout_gift
              - claim_gift
              - checkout_one_time
              - pre_cancel
              - view_voucher
              - accept_quote
              pattern: "^\\[(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote)(,(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`checkout_new\` - Checkout new Subscription \* \`checkout_existing\` - Checkout existing Subscription \* \`update_card\` - \*\*(Deprecated)\*\* Update Card for a Customer \* \`update_payment_method\` - Update Payment Method for a Customer \* \`manage_payment_sources\` - Manage Payments for a customer \* \`collect_now\` - Collect Unpaid Invoices for a Customer \* \`extend_subscription\` - To extend a Subscription period \* \`checkout_gift\` - Checkout a gift subscription \* \`claim_gift\` - Claim a gift subscription \* \`checkout_one_time\` - Checkout one time \* \`pre_cancel\` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription. \* \`view_voucher\` - View Details of a voucher \* \`accept_quote\` - Accept Quote
              enum:
              - checkout_new
              - checkout_existing
              - update_payment_method
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - checkout_gift
              - claim_gift
              - checkout_one_time
              - pre_cancel
              - view_voucher
              - accept_quote
              pattern: "^\\[(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote)(,(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote))*\\\
                ]$"
              example: null
      - name: state
        in: query
        description: |
          optional, enumerated string filter

          Indicating the current state of the hosted page resource. Possible values are : created, requested, succeeded, cancelled, acknowledged.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *state\[is_not\] = "succeeded"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: succeeded
          properties:
            is:
              type: string
              description: |
                \* \`created\` - Indicates the hosted page is just created. \* \`requested\` - Indicates the hosted page is requested by the website \* \`succeeded\` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url. \* \`cancelled\` - Indicates the page is cancelled by the end user after requesting it. \* \`failed\` - \*\*(Deprecated)\*\* Indicates the page submition is failed and response is sent to the return url. \* \`acknowledged\` - Indicates the succeeded hosted page is acknowledged.
              enum:
              - created
              - requested
              - succeeded
              - cancelled
              - acknowledged
              example: null
            is_not:
              type: string
              description: |
                \* \`created\` - Indicates the hosted page is just created. \* \`requested\` - Indicates the hosted page is requested by the website \* \`succeeded\` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url. \* \`cancelled\` - Indicates the page is cancelled by the end user after requesting it. \* \`failed\` - \*\*(Deprecated)\*\* Indicates the page submition is failed and response is sent to the return url. \* \`acknowledged\` - Indicates the succeeded hosted page is acknowledged.
              enum:
              - created
              - requested
              - succeeded
              - cancelled
              - acknowledged
              example: null
            in:
              type: string
              description: |
                \* \`created\` - Indicates the hosted page is just created. \* \`requested\` - Indicates the hosted page is requested by the website \* \`succeeded\` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url. \* \`cancelled\` - Indicates the page is cancelled by the end user after requesting it. \* \`failed\` - \*\*(Deprecated)\*\* Indicates the page submition is failed and response is sent to the return url. \* \`acknowledged\` - Indicates the succeeded hosted page is acknowledged.
              enum:
              - created
              - requested
              - succeeded
              - cancelled
              - acknowledged
              pattern: "^\\[(created|requested|succeeded|cancelled|failed|acknowledged)(,(created|requested|succeeded|cancelled|failed|acknowledged))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`created\` - Indicates the hosted page is just created. \* \`requested\` - Indicates the hosted page is requested by the website \* \`succeeded\` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url. \* \`cancelled\` - Indicates the page is cancelled by the end user after requesting it. \* \`failed\` - \*\*(Deprecated)\*\* Indicates the page submition is failed and response is sent to the return url. \* \`acknowledged\` - Indicates the succeeded hosted page is acknowledged.
              enum:
              - created
              - requested
              - succeeded
              - cancelled
              - acknowledged
              pattern: "^\\[(created|requested|succeeded|cancelled|failed|acknowledged)(,(created|requested|succeeded|cancelled|failed|acknowledged))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this hosted page was last updated.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[on\] = "1490784813"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1490784813"
          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:
                        hosted_page:
                          $ref: "#/components/schemas/HostedPage"
                          description: Resource object representing hosted_page
                      required:
                      - hosted_page
                      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: []
  /hosted_pages/checkout_one_time:
    post:
      summary: Checkout one-time payments
      description: |-
        <div class="api-description"><p class="mb-2">Create a Chargebee hosted page to accept payment from a customer and checkout <a href="/docs/api/v2/pcv-1/addons/addon-object#charge_type">non-recurring addons</a> and <a href="/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge">one-time charges</a>.</p><p class="mb-2">The following steps describe how best to use this API:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Call this endpoint, providing <a href="/docs/api/v2/pcv-1/addons/addon-object#charge_type">non-recurring addons</a>, <a href="/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge">one-time charges</a>, <a href="/docs/api/v2/pcv-1/coupons">coupons</a> and a host of other details such as billing and shipping addresses of the customer, to be prefilled on the checkout page.</li>
        <li class="text-base leading-relaxed">Send the customer to the Checkout <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">url</code> received in the response.</li>
        <li class="text-base leading-relaxed">Once they complete checkout, the non-recurring addons and one-time charges are automatically invoiced against the respective <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> record in Chargebee, and they are redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code> attributes passed as query string parameters.</li>
        <li class="text-base leading-relaxed"><a href="/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page">Retrieve the hosted page</a> at this stage to get the invoice details.</li>
        </ol></div>
      operationId: checkout_one-time_payments
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the invoice amount.
                  maxLength: 3
                  example: null
                invoice_note:
                  type: string
                  deprecated: false
                  description: |
                    A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes)
                    for the invoice are displayed on the PDF invoice sent to the customer.
                  maxLength: 2000
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the coupon as a List. Coupon Codes can also be passed.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                cancel_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.

                    **Note**
                    : - Cancel URL configured in Settings \> Hosted Pages Settings would be overriden by this cancel URL.
                    *Eg : http://yoursite.com?id=\&state=cancelled*

                    * This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.
                  maxLength: 250
                  example: null
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This attribute allows you to store custom information with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object. You can use it to associate specific data with a hosted page session.
                    For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the <a href="/docs/api/v2/pcv-1/hosted_pages/checkout-one-time-payments">redirect URL</a>&#x27;s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.</p>
                  maxLength: 2048
                  example: null
                embed:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

                    **Note**
                    : For [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout, default is false.
                  example: null
                iframe_messaging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \& onCancel callbacks.

                    **Note**
                    : This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout.
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique ID of the customer for which this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>
                        should be created. When not provided, a new customer is created with the ID set to the value provided for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>.
                        If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>
                        is unavailable, then the customer ID is autogenerated.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer. If not provided it will be got from contact information entered in the hosted page
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer. If not provided it will be got from contact information entered in the hosted page
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Company name of the customer.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the customer
                      maxLength: 50
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies if the customer is liable for tax</p>
                        * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                        <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                        </ul>
                        * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                        In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                      enum:
                      - taxable
                      - exempt
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    consolidated_invoicing:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
                      example: null
                  example: null
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase Order Number for this invoice.
                      maxLength: 100
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).
                        Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )
                        can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the addon starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the addon ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                        Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    taxable:
                      type: array
                      description: |
                        The amount to be charged is taxable or not.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    tax_profile_id:
                      type: array
                      description: |
                        Tax profile of the charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_tax_code:
                      type: array
                      description: |
                        The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    hsn_code:
                      type: array
                      description: |
                        The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                        to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                        * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                        * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    taxjar_product_code:
                      type: array
                      description: |
                        The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                          \* retail -

                          Transaction is a sale to an end user
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the charge starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the charge ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/view_voucher:
    post:
      summary: Create a hosted page to view Boleto vouchers
      description: |-
        <div class="api-description"><p class="mb-2">Creates a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>
        resource of type, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">view_voucher</code>
        . When your end customers choose the Boleto payment method, you can generate a voucher for their pending invoice. Using this API, you can create a voucher_detail hosted page for your customers and email them a link to this hosted page. Your customers can review the voucher details on the page by clicking the link in the email.</p></div>
      operationId: create_a_hosted_page_to_view_boleto_vouchers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_voucher:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_voucher
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The unique [ID of the voucher](/docs/api/payment_vouchers/payment_voucher-object#id)
                        which the customer wants to view.
                      maxLength: 40
                      example: null
                  required:
                  - id
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                  example: null
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              payment_voucher:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/checkout_new:
    post:
      summary: Checkout new subscription
      description: |
        Hosted page to accept card details from the subscriber and create a new subscription. This is similar to our server to server API [Create a Subscription](/docs/api/v2/pcv-1/subscriptions/create-a-subscription).

        When the redirect URL is notified of the result, we would advise you to [retrieve the subscription](/docs/api/subscriptions/retrieve-a-subscription) and verify the details.

        #### Related Tutorials

        * [Create a subscription using Chargebee's hosted page](https://www.chargebee.com/checkout-portal-docs/checkout-new-tutorial.html)

        As mentioned before this behavior is very similar to the create subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful creation of subscription.
        Any errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.
      operationId: checkout_new_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                cancel_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.

                    **Note**
                    : - Cancel URL configured in Settings \> Hosted Pages Settings would be overriden by this cancel URL.
                    *Eg : http://yoursite.com?id=\&state=cancelled*

                    * This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.
                  maxLength: 250
                  example: null
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This attribute allows you to store custom information with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object. You can use it to associate specific data with a hosted page session.
                    For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the <a href="/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription#redirect_url">redirect URL</a>&#x27;s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.</p>
                  maxLength: 2048
                  example: null
                embed:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

                    **Note**
                    : For [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout, default is false.
                  example: null
                iframe_messaging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \& onCancel callbacks.

                    **Note**
                    : This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout.
                  example: null
                allow_offline_payment_methods:
                  type: boolean
                  deprecated: false
                  description: |
                    Allow the customer to select an offline payment method during checkout. The choice of payment methods can be configured via the Chargebee UI.
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The time at which the trial ends for this subscription. Can be specified to override the default trial period.If <strong class="font-semibold">&#x27;0&#x27;</strong>
                        is passed, the subscription will be activated immediately. This parameter overrides the Plan&#x27;s <a href="/docs/api/v2/pcv-1/plans"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_period</code></a>
                        directly.</p>
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                        <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                        <li class="text-base leading-relaxed">The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.</li>
                        </ul>
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    invoice_notes:
                      type: string
                      deprecated: false
                      description: |
                        A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                        displayed on the invoice PDF.
                      maxLength: 2000
                      example: null
                    affiliate_token:
                      type: string
                      deprecated: false
                      description: |
                        A unique tracking token
                      maxLength: 250
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  required:
                  - plan_id
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique ID of the customer for which this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>
                        should be created. When not provided, a new customer is created with the ID set to the value provided for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>.
                        If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code>
                        is unavailable, then the customer ID is autogenerated.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer. If not provided it will be got from contact information entered in the hosted page
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer. If not provided it will be got from contact information entered in the hosted page
                      maxLength: 150
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Company name of the customer.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the customer
                      maxLength: 50
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies if the customer is liable for tax</p>
                        * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                        <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                        </ul>
                        * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                        In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                      enum:
                      - taxable
                      - exempt
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    consolidated_invoicing:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/collect_now:
    post:
      summary: Collect Now
      description: "<div class=\"api-description\"><p class=\"mb-2\">This API generates\
        \ a hosted page URL to collect due payments for the customer.</p><div class=\"\
        warning alert alert-warning\"><p class=\"mb-2\"><strong class=\"font-semibold\"\
        >Chargebee.js <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">openCheckout()</code>\
        \ not supported</strong></p><p class=\"mb-2\">The Chargebee.js <a href=\"\
        https://www.chargebee.com/checkout-portal-docs/cbinstanceobj-api-ref.html#opencheckout-options\"\
        \ target=\"_blank\" rel=\"noopener noreferrer\" class=\"text-blue-600 hover:text-blue-800\
        \ underline\"><code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">openCheckout()</code></a>\
        \ function does not support Collect Now hosted pages. To open a Collect Now\
        \ page, open the <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >url</code> from this API&#x27;s response in a new browser tab or window (for\
        \ example, <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">window.open(response.hosted_page.url,\
        \ &#x27;_blank&#x27;)</code>).</p></div></div>"
      operationId: collect_now
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    Used to specify the destination URL to which a user is redirected after invoices are paid. The [transaction ID](/docs/api/transactions/transaction-object#id)
                    of the transactions made through the Pay Now hosted page will be sent as return variables along with the URL.
                  maxLength: 250
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the specified *credit amount*
                    .
                  maxLength: 3
                  example: null
                payment_method_save_policy:
                  type: string
                  deprecated: false
                  description: |
                    Determines whether the payment method should be saved to the customer's account.
                    \* ask -

                    Let the customer choose whether to save the payment method.
                    \* never -

                    Do not save the payment method.
                    \* always -

                    Automatically save the payment method to the customer's account for future use.
                  enum:
                  - always
                  - ask
                  - never
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/checkout_gift:
    post:
      summary: Checkout Gift subscription
      description: "<div class=\"api-description\"><p class=\"mb-2\">Creates a hosted\
        \ page for a customer (called the gifter) to gift a subscription to another\
        \ customer (called the receiver).</p><h4>Gifter customer resource lookup and\
        \ creation</h4><p class=\"mb-2\">When <code><a href=\"/docs/api/hosted_pages/checkout-gift-subscription-for-items#gifter_customer_id\"\
        >gifter[customer_id]</a></code> is provided, it is looked up in Chargebee\
        \ when the gifter completes the hosted page checkout. If not found, a new\
        \ customer resource is created with this ID.</p><h4>Gift receiver customer\
        \ resource lookup and creation</h4><p class=\"mb-2\">Once the gifter checks\
        \ out using the hosted page returned by this endpoint, Chargebee checks if\
        \ a customer resource with the receiver&#x27;s email address exists. The first\
        \ such customer record is considered the receiver&#x27;s customer resource.\
        \ A new customer resource is created for the receiver if none are found.</p></div>"
      operationId: checkout_gift_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](/docs/api/coupon_codes)
                    .
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                gifter:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gifter
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Gifter customer id
                      maxLength: 50
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        Plan Quantity for this subscription in Multi Decimal
                      maxLength: 33
                      example: null
                  required:
                  - plan_id
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              gifter:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/accept_quote:
    post:
      summary: Accept a quote
      description: "This API generates a hosted page URL for the customer to accept\
        \ a quote. If the hosted page URL has expired, a new URL will be generated\
        \ automatically.  \n* Hosted page URL to accept a quote cannot be generated\
        \ for one-time charges.\n* Customers with existing subscriptions can generate\
        \ a quote for new subscriptions. However, Hosted page URL to accept a quote\
        \ cannot be generated for new subscriptions in V1 and V2 hosted pages.\n"
      operationId: accept_a_quote
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                layout:
                  type: string
                  deprecated: false
                  description: |
                    The layout style for the hosted page.
                    \* full_page -

                    Display the hosted page in a full page layout.
                    \* in_app -

                    Display the hosted page in an in-app layout.
                  enum:
                  - in_app
                  - full_page
                  example: null
                quote:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for quote
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The quote number. Acts as a identifier for quote and typically generated sequentially.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              quote:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/claim_gift:
    post:
      summary: Claim a Gift subscription
      description: |
        This API generates a hosted page URL to claim a gifted subscription.
      operationId: claim_a_gift_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                gift:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gift
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a gift
                      maxLength: 150
                      example: null
                  required:
                  - id
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
                      maxLength: 50
                      example: null
                  example: null
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              gift:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/pre_cancel:
    post:
      summary: Create a pre-cancel hosted page
      description: |-
        <div class="api-description"><p class="mb-2">Creates a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>
        resource of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pre_cancel</code>
        . Route canceling users to this page to provide them a retention experience and start saving revenue.
        The hosted page is created in accordance with the retention experience <a href="https://www.chargebee.com/docs/growth/experiences/setting-up-cancel-pages" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">configured in the Chargebee Growth app</a>
        , along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the <strong class="font-semibold">Cancel</strong>
        button, and when they do, route them to the <code><a href="/docs/api/hosted_pages/hosted_page-object#url">url</a></code>
        in the endpoint response.</p></div>
      operationId: create_a_pre-cancel_hosted_page
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Additional data to be passed to Chargebee Growth. Only the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pass_thru_content.custom</code> is sent to Chargebee Growth. It is sent as the value of the <a href="https://www.chargebee.com/checkout-portal-docs/cancel-page-api-ref.html#parameters" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">custom</code></a> property. The fields provided in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pass_thru_content.custom</code> must be preconfigured in Chargebee Growth.</p>
                    <p class="mb-2">Although only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pass_thru_content.custom</code> is sent to Chargebee Growth, all of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pass_thru_content</code> is stored by Chargebee Billing and is retrievable as an <a href="/docs/api/hosted_pages/hosted_page-object#pass_thru_content">attribute</a> of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code>.
                    .</p>
                  maxLength: 2048
                  example: null
                cancel_url:
                  type: string
                  deprecated: false
                  description: |
                    The customer is sent to this URL if they finally decide to cancel the subscription, despite the attempt to retain them.
                  maxLength: 250
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    The customer is sent to this URL upon successful retention. In other words, this is the page to which the customer is sent when they decide **not**
                    to cancel the subscription.
                  maxLength: 250
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The unique ID of the subscription which the customer wants to cancel.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/{hosted-page-id}/acknowledge:
    post:
      summary: Acknowledge a hosted page
      description: |-
        <div class="api-description"><p class="mb-2">When a hosted page is successfully completed by the user and processed by Chargebee, its <a href="/docs/api/hosted_pages/hosted_page-object#state"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code></a>
        is automatically changed to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">succeeded</code>
        . Acknowledging a hosted page confirms that you have moved the customer details from Chargebee into your system and are ready to fulfill it. This API is used to acknowledge the hosted page in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">succeeded</code>
        state and change its state to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">acknowledged</code>
        .</p><p class="mb-2"><strong class="font-semibold">Note:</strong>
        The hosted page status must be succeeded for this API call to be allowed.</p></div>
      operationId: acknowledge_a_hosted_page
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: hosted-page-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/hosted-page-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/retrieve_agreement_pdf:
    post:
      summary: Retrieve Direct Debit Agreement PDF
      description: |
        This is applicable only for Direct Debit via SEPA, Bacs, Bg Autogiro, BECS (for both Australia and New Zealand) and PAD. For Direct Debit, the customer needs to accept an agreement that allows the merchant to debit their bank account. This agreement PDF allows you to easily display scheme-rules compliant Direct Debit mandates to your customers.

        This API retrieves the redirect link to the corresponding agreement for customers. The agreement PDF can be your "Thank You" page or sent by email to customers. Communicating this PDF to your customers is mandatory.

        Customer locale is used to generate the PDF in the required language. If a customer language is not supported, the PDF is generated in English. Checkout the [list of languages](https://developer.gocardless.com/api-reference/#mandate-pdfs-create-a-mandate-pdf) supported by GoCardless.
      operationId: retrieve_direct_debit_agreement_pdf
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
              required:
              - payment_source_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/{hosted-page-id}:
    get:
      summary: Retrieve a hosted page
      description: |
        Retrieves a hosted page resource.
      operationId: retrieve_a_hosted_page
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: hosted-page-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/hosted-page-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/manage_payment_sources:
    post:
      summary: Manage Payment Sources
      description: |
        This API generates a hosted page URL to add new or update existing payment sources for the customer.
      operationId: manage_payment_sources
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /hosted_pages/checkout_existing:
    post:
      summary: Checkout existing subscription
      description: |
        You can checkout an existing subscription(typically in the trial state) by passing in the plan, quantity and addon details(like [Update a Subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription))

        When the redirect URL is notified of the result, we would advise you to [retrieve the subscription](/docs/api/subscriptions/retrieve-a-subscription) and verify the details.

        #### Related Tutorial

        * [Upgrade existing subscription using Chargebee's hosted page](https://www.chargebee.com/checkout-portal-docs/checkout-existing-tutorial.html)

        As mentioned before this behavior is very similar to the update subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful checkout of subscription.
        Any errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.
      operationId: checkout_existing_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                replace_addon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing addons should be replaced with the ones that are being passed.
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date.  taxes and line_item_taxes are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    .</li>
                    </ul>
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">If the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changed_scheduled_at</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating must be enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is on or after the last date/time any of the product catalog items of the subscription were changed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    chosen for the site for calendar billing. Only applicable when using calendar billing.
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    then the existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    list for the subscription is replaced by the one provided. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    then the provided <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    list gets added to the existing list.</p>
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>: This parameter is relevant only for subscriptions with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.</p></div>
                    <p class="mb-2">When you set this parameter to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, the subscription term resets to the date of the subscription change.
                    By default, if you change the plan to another with the same billing period, the subscription term remains unchanged. For example, if the subscription renews on the 28th of every month, it will continue to renew on the 28th after the change.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>: If the new plan has a different billing period from the current plan, the subscription term resets automatically, regardless of the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>.</p></div>
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong> :</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Although the customer will be redirected to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">redirect_url</code> after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_created</code></a> or <a href="/docs/api/events" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_generated</code></a> to verify a successful checkout.</li>
                    <li class="text-base leading-relaxed">Redirect URL configured in Settings &gt; Hosted Pages Settings would be overriden by this redirect URL.</li>
                    <li class="text-base leading-relaxed"><em class="italic">Eg :</em> <em class="italic">http://yoursite.com?id=**&amp;state=succeeded</em></li>
                    <li class="text-base leading-relaxed">This parameter is not applicable for iframe messaging.</li>
                    </ul>
                  maxLength: 250
                  example: null
                cancel_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.

                    **Note**
                    : - Cancel URL configured in Settings \> Hosted Pages Settings would be overriden by this cancel URL.
                    *Eg : http://yoursite.com?id=\&state=cancelled*

                    * This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.
                  maxLength: 250
                  example: null
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This attribute allows you to store custom information with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object. You can use it to associate specific data with a hosted page session.
                    For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the <a href="/docs/api/v2/pcv-1/hosted_pages/checkout-existing-subscription#redirect_url">redirect URL</a>&#x27;s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.</p>
                  maxLength: 2048
                  example: null
                embed:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

                    **Note**
                    : For [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout, default is false.
                  example: null
                iframe_messaging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \& onCancel callbacks.

                    **Note**
                    : This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)
                    checkout.
                  example: null
                allow_offline_payment_methods:
                  type: boolean
                  deprecated: false
                  description: |
                    Allow the customer to select an offline payment method during checkout. The choice of payment methods can be configured via the Chargebee UI.
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Represents the plan quantity for this subscription.
                      minimum: 1
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The new start date of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscription. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscriptions.</p>
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        , or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.
                        Also, the value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.
                        <strong class="font-semibold">Note</strong>:
                        This parameter can be backdated (set to a value in the past) only when the subscription is in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>
                        is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                        status. This parameter overrides the Plan&#x27;s <a href="/docs/api/v2/pcv-1/plans"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_period</code></a>
                        directly.</p>
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    invoice_notes:
                      type: string
                      deprecated: false
                      description: |
                        A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
                        displayed on the invoice PDF.
                      maxLength: 2000
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  required:
                  - id
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
                        can be overridden by setting
                        <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
                        .</p>
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for card
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account in which this payment source is stored.
                      maxLength: 50
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: <p class="mb-2">Resource object representing hosted_page</p>
                required:
                - hosted_page
                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: []
  /subscriptions/{subscription-id}/renewal_estimate:
    get:
      summary: Subscription renewal estimate
      description: "This returns an estimate of the amount that will be charged when\
        \ the subscription is billed next. The estimate is calculated based on the\
        \ current recurring items of the subscription - plan, addons, and coupons.\n\
        \nIn the response,\n\n* **estimate.subscription_estimate** has the current\
        \ subscription details like its status, next billing date, and so on.\n\n\
        **estimate.invoice_estimate**\nhas details of the invoice that will be generated\
        \ at the next billing date.  \nThe generated invoice estimate will include\
        \ all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html)\n\
        , Refundable Credits, and Excess Payments - if any. If you don't want these\
        \ balances to be included you can specify 'false' for the parameter *use_existing_balances*\n\
        .  \nTo exclude the [delayed charges](https://www.chargebee.com/docs/charges.html)\n\
        from the invoice estimate, specify 'false' for the parameter *include_delayed_charges*\n\
        .\n\n**Note:**\n\n* This API will not generate a renewal invoice if an [advance\
        \ invoice](https://www.chargebee.com/docs/advance-invoices.html) is already\
        \ present for the subscription.\n* For 'Non Renewing' subscriptions, only\
        \ the [delayed charges](https://www.chargebee.com/docs/charges.html) will\
        \ be included in the invoice estimate.\n* This API is not supported for 'Cancelled'\
        \ subscriptions.\n* Only the subscription's charges will be included. If you\
        \ have enabled the Consolidated invoicing feature, use the *Upcoming Invoices*\
        \ estimate available for the Customer object to get the actual estimate invoice\
        \ for the customer.\n"
      operationId: subscription_renewal_estimate
      parameters:
      - name: include_delayed_charges
        in: query
        description: |
          If true, all the unbilled charges will be included for the invoice estimate.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: true
          deprecated: false
          example: null
      - name: use_existing_balances
        in: query
        description: "<p class=\"mb-2\">The generated invoice_estimate/next_invoice_estimate\
          \ will include all the balances - Promotional Credits, Refundable Credits,\
          \ and Excess Payments - if any. If you don&#x27;t want these balances to\
          \ be included you can specify &#x27;false&#x27; for the parameter <code\
          \ class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded\
          \ px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">use_existing_balances</code>.</p>"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: true
          deprecated: false
          example: null
      - name: ignore_scheduled_cancellation
        in: query
        description: |
          if true, ignores scheduled cancellation for non renewing subscription.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          deprecated: false
          example: null
      - name: ignore_scheduled_changes
        in: query
        description: |
          If true, ignores all recurring charges scheduled during renewal.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          deprecated: false
          example: null
      - name: exclude_tax_type
        in: query
        description: |
          Indicates whether tax calculation should be excluded for the operation. This attribute is applicable only when a third-party tax provider is configured. If no such provider is set up, this parameter will be ignored.
          \* exclusive -

          Excludes only **exclusive** tax calculations, and only when exclusive taxes are applicable.
          \* none -

          No exclusions are applied. All applicable taxes are calculated based on the standard tax configuration.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          default: none
          deprecated: false
          enum:
          - exclusive
          - none
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /estimates/update_subscription:
    post:
      summary: Update subscription estimate
      description: |-
        <div class="api-description"><p class="mb-2">Generates an estimate for the &#x27;update subscription&#x27; operation. The input will be similar to the <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">Update Subscription</a> API but subscription will not be updated, only an estimate will be created.</p><p class="mb-2">In the response,</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code><a href="/docs/api/estimates/estimate-object">subscription_estimate</a></code>: The details of the changed subscription such as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, next billing date, and so on.</li>
        <li class="text-base leading-relaxed"><code><a href="/docs/api/estimates/estimate-object">invoice_estimate</a></code>:The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:
        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_of_term</code> parameter is true</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">prorate</code> parameter is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code></li>
        <li class="text-base leading-relaxed">No changes are made to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addons</code>.</li>
        <li class="text-base leading-relaxed">For changes such as <a href="https://www.chargebee.com/docs/proration.html#proration-mechanism_plan-quantity-downgrade-paid-invoice" target="_blank">quantity downgrades</a>.</li>
        </ul>
        </li>
        <li class="text-base leading-relaxed"><code><a href="/docs/api/estimates/estimate-object">next_invoice_estimate</a></code>:The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.</li>
        <li class="text-base leading-relaxed"><code><a href="/docs/api/estimates/estimate-object">credit_note_estimates</a></code>:The list of credit notes (if any) generated during this operation.</li>
        <li class="text-base leading-relaxed"><code><a href="/docs/api/estimates/estimate-object">unbilled_charge_estimates</a></code>: The details of charges that have not been invoiced. This is returned only if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> parameter is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>.</li>
        </ul><p class="mb-2"><strong class="font-semibold">Note:</strong> If you have configured <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a> or <a href="https://www.chargebee.com/docs/customized-tax.html" target="_blank">Customized taxes</a>, you need to specify the applicable parameters for calculating taxes - <em class="italic">billing_address[]</em>, <em class="italic">shipping_address[]</em>, <em class="italic">customer[vat_number]</em>, <em class="italic">customer[taxability]</em> etc. Otherwise tax calculation will be ignored.</p></div>
      operationId: update_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                    , then set the date/time at which the subscription change is to happen or has happened. <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Backdating must be enabled for subscription change operations.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Only the following changes can be backdated:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after the last date/time any of the following changes were made:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</p>
                    </li>
                    </ul>
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.</p>
                    * end_of_term - <p class="mb-2">The change is carried out at the end of the current billing cycle of the subscription.</p>
                    * specific_date - <p class="mb-2">The change is carried out as of the date specified under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    .</p>
                    * immediately - <p class="mb-2">The change is carried out immediately.</p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  example: null
                replace_addon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing addons should be replaced with the ones that are being passed.
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date.  taxes and line_item_taxes are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    .</li>
                    </ul>
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">If the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changed_scheduled_at</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating must be enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is on or after the last date/time any of the product catalog items of the subscription were changed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    chosen for the site for calendar billing. Only applicable when using calendar billing.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](/docs/api/coupon_codes)
                    .
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    then the existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    list for the subscription is replaced by the one provided. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    then the provided list gets added to the existing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon_ids</code>
                    .</p>
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism" target="_blank">Prorated credits or charges</a> are created as applicable for this change.</li>
                    <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: The subscription is changed without creating any credits or charges.</li>
                    <li class="text-base leading-relaxed">When not provided, the value configured in the <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site settings</a> is considered.</li>
                    </ul>
                    <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Caveat</strong></p><p class="mb-2">For further changes within the same billing term, when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">prorate</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, <strong class="font-semibold">credits</strong> are <strong class="font-semibold">not created</strong> when <strong class="font-semibold">all</strong> the conditions below hold true:</p><p class="mb-2">An immediate previous change was made</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">prorate</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> and</li>
                    <li class="text-base leading-relaxed">no changes were made to the subscription&#x27;s billing term and</li>
                    <li class="text-base leading-relaxed">a change was made to either the subscription&#x27;s plan, its addons, or the prices of the plan or addons.</li>
                    </ul></div>
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    will have the subscription reset its term to the current date (provided <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_of_term</code>
                    is false).
                    <strong class="font-semibold">Note</strong>:
                    When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.</p>
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    subscriptions. When passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , the canceled subscription is activated; otherwise subscription changes are made without changing its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.
                    If not passed, subscription will be activated only if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items</code>
                    is passed.</p>
                  example: null
                include_delayed_charges:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If true, all the unbilled charges will be included for the invoice estimate.
                  example: null
                use_existing_balances:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter *use_existing_balances*
                    .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Represents the plan quantity for this subscription.
                      minimum: 1
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The new start date of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscription. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscriptions.</p>
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        , or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.
                        Also, the value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.
                        <strong class="font-semibold">Note</strong>:
                        This parameter can be backdated (set to a value in the past) only when the subscription is in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>
                        is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                        status.</p>
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    free_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
                      minimum: 1
                      example: null
                    free_period_unit:
                      type: string
                      deprecated: false
                      description: |
                        The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                        attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                        chosen.
                        \* year -

                        Charge based on year(s)
                        \* day -

                        Charge based on day(s)
                        \* month -

                        Charge based on month(s)
                        \* week -

                        Charge based on week(s)
                      enum:
                      - day
                      - week
                      - month
                      - year
                      example: null
                    trial_end_action:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Applicable only when <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">End-of-trial Action</a>
                        has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.</p>
                        * activate_subscription - <p class="mb-2">The subscription activates and charges are raised for non-metered items.</p>
                        * cancel_subscription - <p class="mb-2">The subscription cancels.</p>
                        * plan_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a>
                        at the time when the trial ends, takes effect. This is the default value when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end_action</code>
                        is defined for the plan.</p>
                        * site_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a>
                        at the time when the trial ends, takes effect. This is the default value when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end_action</code>
                        is <strong class="font-semibold">not</strong>
                        defined for the plan.</p>
                      enum:
                      - site_default
                      - plan_default
                      - activate_subscription
                      - cancel_subscription
                      example: null
                  required:
                  - id
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. To update this value, redo the complete addon set using <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">replace_addon_list</code></a>.
                        (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        .)</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    proration_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Specifies how to manage charges or credits for the addon for this estimate. It&#x27;s relevant only for addons that have their <code><a href="/docs/api/v2/pcv-1/addons/addon-object#pricing_model">pricing_model</a></code>
                          set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.
                          You may use this parameter only if the change to the subscription takes effect <a href="/docs/api/v2/pcv-1/estimates/update-subscription-estimate#end_of_term">immediately</a>.</p>
                          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                          If you don&#x27;t provide a value, Chargebee determines the proration logic based on the following precedence: this parameter &gt; <code><a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#prorate">prorate</a></code> parameter &gt; <code><a href="/docs/api/v2/pcv-1/addons/addon-object#proration_type">addon.proration_type</a></code> &gt; <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration</a> setting.</p></div>
                          <span featureId="cb-addon-proration" isMicro="true"></span>
                          * full_term - <p class="mb-2">Charge the full price of the addon or give the full credit. Don&#x27;t apply any proration.</p>
                          * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p>
                          * none - <p class="mb-2">Don&#x27;t apply any charges or credits for the addon.</p>
                        enum:
                        - full_term
                        - partial_term
                        - none
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/resume_subscription_estimate:
    post:
      summary: Resume subscription estimate
      description: "Generates an estimate for the 'resume subscription' operation.\
        \ This is similar to the [Resume a subscription](/docs/api/subscriptions/resume-a-subscription)\
        \ API, but the subscription will not be resumed. Only an estimate for this\
        \ operation is created.\n\nIn the response,\n\n* **estimate.subscription_estimate**\
        \ has the subscription details.\n\n**estimate.invoice_estimate**\nhas details\
        \ of the invoice that will be generated immediately. This will not be present\
        \ if no immediate invoice is generated for this operation. This will happen\
        \ for in-term resumption++\n.  \n**++What is an \"in-term resumption\"?**\n\
        \nAn \"in-term resumption\" is when the resumption happens within the billing\
        \ term of the subscription.\n\n**estimate.next_invoice_estimate**\nhas details\
        \ of the invoice that will be generated during the next billing date of this\
        \ subscription. This will be present only if no immediate invoice is generated\
        \ during this operation (scenario mentioned above) and this subscription has\
        \ next billing.  \nThe generated invoice_estimate/next_invoice_estimate will\
        \ include all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html)\n\
        , Refundable Credits, and Excess Payments - if any.\n"
      operationId: resume_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                resume_option:
                  type: string
                  deprecated: false
                  description: |
                    List of options to resume the subscription.
                    \* immediately -

                    Resume immediately
                    \* specific_date -

                    Resume on a specific date
                  enum:
                  - immediately
                  - specific_date
                  example: null
                charges_handling:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when charges get added during this operation and **resume_option**
                    is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.
                    \* add_to_unbilled_charges -

                    Add to unbilled charges
                    \* invoice_immediately -

                    Invoice immediately
                  enum:
                  - invoice_immediately
                  - add_to_unbilled_charges
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    resume_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
                      example: null
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /estimates/gift_subscription:
    post:
      summary: Gift subscription estimate
      description: |
        Generates an estimate for the 'create a gift' operation. This is similar to the [Create a gift](/docs/api/v2/pcv-1/gifts/create-a-gift) API, but the gift subscription will not be created. Only an estimate for this operation is created.

        In the response,

        * **estimate.subscription_estimate** has the gift subscription details.
        * **estimate.invoice_estimate** has details of the gift invoice that will be generated immediately.
      operationId: gift_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                gift:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gift
                  properties:
                    scheduled_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
                      example: null
                    auto_claim:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |-
                        <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , the claim happens automatically. When not passed, the default value in the site settings is used.</p>
                      example: null
                    no_expiry:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , indicates that the gift does not expire. Do not pass or pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
                        is set.</p>
                      example: null
                    claim_expiry_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date until which the gift can be claimed. Must be set to a value after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheduled_at</code>.
                        If the gift is not claimed within <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">claim_expiry_date</code>
                        , it will expire and the subscription will move to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        state. When not passed, the value specified in the site settings will be used.
                        Pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NULL</code>
                        or do not pass when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">no_expiry</code>
                        are set.</p>
                      example: null
                  example: null
                gifter:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gifter
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Gifter customer id.
                      maxLength: 50
                      example: null
                    signature:
                      type: string
                      deprecated: false
                      description: |
                        Gifter sign-off name
                      maxLength: 50
                      example: null
                    note:
                      type: string
                      deprecated: false
                      description: |
                        Personalized message for the gift.
                      maxLength: 500
                      example: null
                    payment_src_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the payment source
                      maxLength: 40
                      example: null
                  required:
                  - customer_id
                  - signature
                  example: null
                gift_receiver:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gift_receiver
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Receiver customer id.
                      maxLength: 50
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the receiver as given by the gifter.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the receiver as given by the gifter,
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the receiver. All gift related emails are sent to this email.
                      maxLength: 70
                      example: null
                  required:
                  - customer_id
                  - email
                  - first_name
                  - last_name
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
                      maxLength: 150
                      example: null
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: |
                        The gateway account used for performing the 3DS flow.
                      maxLength: 50
                      example: null
                    gw_token:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)
                        to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    payment_method_type:
                      type: string
                      deprecated: false
                      description: |
                        The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
                        \* card -

                        card
                        \* twint -

                        Payments made via Twint
                        \* swish -

                        Payments made via Swish
                        \* after_pay -

                        Payments made via Afterpay
                        \* netbanking_emandates -

                        netbanking_emandates
                        \* grab_pay -

                        Payments made via GrabPay
                        \* payconiq_by_bancontact -

                        Payments made via Payconiq by Bancontact.
                        \* dotpay -

                        dotpay
                        \* faster_payments -

                        Faster Payments
                        \* upi -

                        upi
                        \* kbc_payment_button -

                        KBC Payment Button
                        \* electronic_payment_standard -

                        Electronic Payment Standard
                        \* payme -

                        Payments made via PayMe
                        \* direct_debit -

                        direct_debit
                        \* sepa_instant_transfer -

                        Sepa Instant Transfer
                        \* bancontact -

                        bancontact
                        \* go_pay -

                        Payments made via GoPay
                        \* pay_by_bank -

                        Pay By Bank
                        \* google_pay -

                        google_pay
                        \* apple_pay -

                        apple_pay
                        \* trustly -

                        Trustly
                        \* naver_pay -

                        Payments made via Naver Pay.
                        \* stablecoin -

                        Payments made via Stablecoin.
                        \* giropay -

                        giropay
                        \* paypal_express_checkout -

                        paypal_express_checkout
                        \* pix -

                        Pix
                        \* venmo -

                        Venmo
                        \* klarna_pay_now -

                        Klarna Pay Now
                        \* alipay -

                        Payments made via Alipay.
                        \* sofort -

                        sofort
                        \* amazon_payments -

                        Amazon Payments
                        \* ideal -

                        ideal
                        \* kakao_pay -

                        Payments made via Kakao Pay.
                        \* pay_to -

                        PayTo
                        \* boleto -

                        boleto
                        \* pay_co -

                        Payments made via PayCo
                        \* revolut_pay -

                        Payments made via Revolut Pay.
                        \* wechat_pay -

                        Payments made via WeChat Pay.
                        \* cash_app_pay -

                        Payments made via Cash App Pay.
                      enum:
                      - card
                      - ideal
                      - sofort
                      - bancontact
                      - google_pay
                      - dotpay
                      - giropay
                      - apple_pay
                      - upi
                      - netbanking_emandates
                      - paypal_express_checkout
                      - direct_debit
                      - boleto
                      - venmo
                      - amazon_payments
                      - pay_to
                      - faster_payments
                      - sepa_instant_transfer
                      - klarna_pay_now
                      - online_banking_poland
                      - payconiq_by_bancontact
                      - electronic_payment_standard
                      - kbc_payment_button
                      - pay_by_bank
                      - trustly
                      - stablecoin
                      - kakao_pay
                      - naver_pay
                      - revolut_pay
                      - cash_app_pay
                      - wechat_pay
                      - alipay
                      - twint
                      - go_pay
                      - grab_pay
                      - pay_co
                      - after_pay
                      - swish
                      - payme
                      - pix
                      - klarna
                      example: null
                    reference_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
                      maxLength: 65000
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |-
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user&#x27;s <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device.</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed">
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user&#x27;s identification number based on their country.</li>
                        </ul>
                        </li>
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information.
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user&#x27;s device</li>
                        </ul>
                        </li>
                        </ul>
                        </li>
                        </ul>
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        Plan Quantity for this subscription in Multi Decimal
                      maxLength: 33
                      example: null
                  required:
                  - plan_id
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              gift:
                style: deepObject
                explode: true
              gift_receiver:
                style: deepObject
                explode: true
              gifter:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /customers/{customer-id}/upcoming_invoices_estimate:
    get:
      summary: Upcoming invoices estimate
      description: |
        Estimate of the upcoming scheduled invoices (subscription activations, renewals etc) of a customer. For now preview of the invoices generated on the immediate upcoming date is supported. Say a customer has couple of subscription renewals scheduled on *Jan,10th* and another subscription renewal scheduled on *Jan,15th* . This API gives the preview of all the invoices scheduled to be generated on *Jan,10th* (immediate upcoming date).

        In the response:

        * **estimate.invoice_estimates\[\]** has details of the invoices scheduled to be generated.

        **Note:** If *consolidated invoicing* is enabled you may use this API to test whether upcoming renewals are consolidated.
      operationId: upcoming_invoices_estimate
      parameters:
      - name: include_usage_charges
        in: query
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          deprecated: false
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/regenerate_invoice_estimate:
    post:
      summary: Regenerate Invoice Estimate
      description: |-
        <div class="api-description"><p class="mb-2">Regenerates the invoice for the current term of the subscription. The subscription must have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>. This operation is not allowed when any of the following conditions hold true for the subscription:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">An invoice exists for the current term and its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">voided</code>.</li>
        <li class="text-base leading-relaxed">There are <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank" rel="noopener noreferrer">unbilled charges</a> for the current term.</li>
        <li class="text-base leading-relaxed">The subscription has an <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank" rel="noopener noreferrer">advance invoice</a>.</li>
        </ul><h4>Response</h4><p class="mb-2">Returns an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">estimate</code> object with one of the following components depending on the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">If the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_estimate</code> object that corresponds to the regenerated invoice.</li>
        <li class="text-base leading-relaxed">If the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: a list of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unbilled_charge_estimate</code> objects corresponding to all the unbilled charges created for the current term of the subscription.</li>
        </ul></div>
      operationId: regenerate_invoice_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                date_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The start date of the period being invoiced. The default value is [current_term_start](/docs/api/subscriptions/subscription-object#current_term_start)
                    .
                  example: null
                date_to:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The end date of the period being invoiced. The default value is [current_term_end](/docs/api/subscriptions/subscription-object#current_term_end)
                    .
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the charges should be prorated according to the term specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_from</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_to</code>.
                    Should not be passed without <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_from</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_to</code>
                    .</p>
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Only applicable when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html " target="_blank">Consolidated Invoicing</a>
                    is enabled for the customer. Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    to leave the current term charge for the subscription as <a href="https://www.chargebee.com/docs/unbilled-charges.html " target="_blank">unbilled</a>.
                    Once you have done this for all suitable subscriptions of the customer, call <a href="/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges" target="_blank">Create an invoice for unbilled charges</a>
                    to invoice them.</p>
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /customers/{customer-id}/create_subscription_estimate:
    get:
      summary: Create subscription for a customer estimate
      description: |
        Create a subscription for the existing estimate of a customer.
      operationId: create_subscription_for_a_customer_estimate
      parameters:
      - name: use_existing_balances
        in: query
        description: |
          The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter *use_existing_balances*
          .
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: true
          deprecated: false
          example: null
      - name: invoice_immediately
        in: query
        description: |-
          <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
          The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
          .</p>
          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
          <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
          only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
          <p class="mb-2">.</p>
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          deprecated: false
          example: null
      - name: billing_cycles
        in: query
        description: |
          Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          deprecated: false
          minimum: 0
          example: null
      - name: mandatory_addons_to_remove
        in: query
        description: |
          List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: array
          deprecated: false
          items:
            type: string
            deprecated: false
            x-cb-parameter-blank-option: as_null
            x-cb-attribute-meta-comment: optional
            x-cb-is-api-column: true
            maxLength: 100
            example: null
          example: null
      - name: terms_to_charge
        in: query
        description: |
          The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
          .
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          deprecated: false
          minimum: 1
          example: null
      - name: billing_alignment_mode
        in: query
        description: |
          Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
          for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
          \* delayed -

          Subscription period will be aligned with the configured billing date at the next renewal.
          \* immediate -

          Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - immediate
          - delayed
          example: null
      - name: invoice_date
        in: query
        description: |-
          <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
          <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
          and
          <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
          are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      - name: coupon_ids
        in: query
        description: |
          List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: array
          deprecated: false
          items:
            type: string
            deprecated: false
            x-cb-parameter-blank-option: as_null
            x-cb-attribute-meta-comment: optional
            x-cb-is-api-column: true
            maxLength: 100
            example: null
          example: null
      - name: subscription
        in: query
        description: |
          Parameters for subscription
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            id:
              type: string
              deprecated: false
              description: |
                A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
              maxLength: 50
              example: null
            plan_id:
              type: string
              deprecated: false
              description: |
                Identifier of the plan for this subscription
              maxLength: 100
              example: null
            plan_quantity:
              type: integer
              format: int32
              default: 1
              deprecated: false
              description: |
                Plan quantity for this subscription
              minimum: 1
              example: null
            plan_quantity_in_decimal:
              type: string
              deprecated: false
              description: |
                The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                is enabled.
              maxLength: 33
              example: null
            plan_unit_price:
              type: integer
              format: int64
              deprecated: false
              description: |
                Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                .
              minimum: 0
              example: null
            plan_unit_price_in_decimal:
              type: string
              deprecated: false
              description: |
                When [price overriding](http://chargebee.com/docs/price-override.html )
                is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                is enabled.
              maxLength: 39
              example: null
            setup_fee:
              type: integer
              format: int64
              deprecated: false
              description: |
                Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                .
              minimum: 0
              example: null
            trial_end:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                is passed, the subscription will be activated immediately.
              example: null
            start_date:
              type: integer
              format: unix-time
              deprecated: false
              description: |-
                <p class="mb-2">The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                <li class="text-base leading-relaxed">The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.</li>
                </ul>
              example: null
            offline_payment_method:
              type: string
              deprecated: false
              description: |
                The preferred offline payment method for the subscription.
              enum:
              - no_preference
              - cash
              - check
              - bank_transfer
              - ach_credit
              - sepa_credit
              - boleto
              - us_automated_bank_transfer
              - eu_automated_bank_transfer
              - uk_automated_bank_transfer
              - jp_automated_bank_transfer
              - mx_automated_bank_transfer
              - custom
              example: null
            free_period:
              type: integer
              format: int32
              deprecated: false
              description: |
                The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
              minimum: 1
              example: null
            free_period_unit:
              type: string
              deprecated: false
              description: |
                The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                chosen.
              enum:
              - day
              - week
              - month
              - year
              example: null
            contract_term_billing_cycle_on_renewal:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                .</p>
              maximum: 100
              minimum: 1
              example: null
            trial_end_action:
              type: string
              deprecated: false
              description: |
                Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
              enum:
              - site_default
              - plan_default
              - activate_subscription
              - cancel_subscription
              example: null
          required:
          - plan_id
          example: null
      - name: shipping_address
        in: query
        description: |
          Parameters for shipping_address
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
      - name: contract_term
        in: query
        description: |
          Parameters for contract_term
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            action_at_term_end:
              type: string
              deprecated: false
              description: |
                Action to be taken when the contract term completes.
              enum:
              - renew
              - evergreen
              - cancel
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              default: 0
              deprecated: false
              description: |-
                <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
              example: null
          example: null
      - name: addons
        in: query
        description: |
          Parameters for addons
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            id:
              type: array
              description: |
                Identifier of the addon. Multiple addons can be passed.
              items:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              example: null
            quantity:
              type: array
              description: |-
                <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                .</p>
              items:
                type: integer
                format: int32
                default: 1
                deprecated: false
                minimum: 1
                example: null
              example: null
            quantity_in_decimal:
              type: array
              description: |
                The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                is enabled.
              items:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              example: null
            unit_price:
              type: array
              description: |-
                <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                </ul></div>
              items:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              example: null
            unit_price_in_decimal:
              type: array
              description: |-
                <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                is enabled.</p>
              items:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              example: null
            billing_cycles:
              type: array
              description: |
                Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
              items:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              example: null
            trial_end:
              type: array
              description: |-
                <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                )</p>
              items:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              example: null
          example: null
      - name: event_based_addons
        in: query
        description: |
          Parameters for event_based_addons
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            id:
              type: array
              description: |
                A unique 'id' used to identify the addon.
              items:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              example: null
            quantity:
              type: array
              description: |-
                <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                .</p>
              items:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              example: null
            unit_price:
              type: array
              description: |
                Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                .
              items:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              example: null
            quantity_in_decimal:
              type: array
              description: |
                The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                is enabled.
              items:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              example: null
            unit_price_in_decimal:
              type: array
              description: |
                When [price overriding](http://chargebee.com/docs/price-override.html )
                is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                is enabled.
              items:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              example: null
            service_period_in_days:
              type: array
              description: |
                Defines service period of the addon in days from the day of charge.
              items:
                type: integer
                format: int32
                deprecated: false
                maximum: 4000
                minimum: 1
                example: null
              example: null
            on_event:
              type: array
              description: |
                Event on which this addon will be charged.
              items:
                type: string
                deprecated: false
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              example: null
            charge_once:
              type: array
              description: |
                If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
              items:
                type: boolean
                default: true
                deprecated: false
                example: null
              example: null
            charge_on:
              type: array
              description: |
                Indicates when the non-recurring addon will be charged.
              items:
                type: string
                deprecated: false
                enum:
                - immediately
                - on_event
                example: null
              example: null
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/change_term_end_estimate:
    post:
      summary: Subscription change term end estimate
      description: |
        Generates an estimate for the 'change term end' operation. This is similar to the [Change term end](/docs/api/subscriptions/change-term-end) API but the subscription's term end will not be changed, only an estimate for this operation is created. This is applicable only for subscriptions in 'in-trial', 'active' and 'non-renewing' states.

        In the response,

        * **estimate.subscription_estimate** has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.
        * **estimate.invoice_estimate** has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen when
          * *prorate* parameter is false, or
          * *invoice_immediately* parameter is false, or
          * subscription is in *in-trial* state
        * **estimate.credit_note_estimates\[\]** has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.
        * **estimate.unbilled_charge_estimates\[\]** has details of the unbilled charges. This is returned only if *invoice_immediately* is set as false.
      operationId: subscription_change_term_end_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                term_ends_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the current term should end for this subscription.
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable for *active*
                    / *non_renewing*
                    subscriptions. If specified as *true*
                    prorated charges / credits will be added during this operation.
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
              required:
              - term_ends_at
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/pause_subscription_estimate:
    post:
      summary: Pause subscription estimate
      description: |-
        <div class="api-description"><p class="mb-2">This API provides an estimate of the details pertaining to the <code><a href="/docs/api/subscriptions/pause-a-subscription">pause_subscription</a></code> operation. It returns attributes such as <code><a href="/docs/api/estimates/estimate-object#subscription_estimate_pause_date">pause_date</a></code> and <code><a href="/docs/api/estimates/estimate-object#subscription_estimate_resume_date">resume_date</a></code>. This is similar to the <a href="/docs/api/subscriptions/pause-a-subscription">Pause a subscription</a> API with the exception that the subscription is not paused. Only an estimate for this operation is created.</p><p class="mb-2">In the response,</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">estimate.subscription_estimate</strong> has the subscription details.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">estimate.invoice_estimate</strong> has details of the invoice that are generated immediately. This is not present if no immediate invoices are generated for this operation.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">estimate.credit_note_estimates[]</strong> has details of the credit notes that are generated during this operation. This list is empty if no credit notes are generated.</li>
        </ul></div>
      operationId: pause_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                pause_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">List of options to pause the subscription.</p>
                    * billing_cycles - <p class="mb-2">Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in <code><a href="/docs/api/subscriptions/pause-a-subscription#skip_billing_cycles">skip_billing_cycles</a></code></p>
                    * immediately - <p class="mb-2">Pause immediately</p>
                    * end_of_term - <p class="mb-2">Pause at the end of current term</p>
                    * specific_date - <p class="mb-2">Pause on a specific date</p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - billing_cycles
                  example: null
                unbilled_charges_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Applicable when unbilled charges are present for the subscription and <code><a href="/docs/api/estimates/pause-subscription-estimate#pause_option">pause_option</a></code> is set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>. <strong class="font-semibold">Note:</strong> On the invoice raised, an automatic charge is attempted on the payment method available, if customer&#x27;s auto-collection property is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>.</p>
                    * invoice - <p class="mb-2">Invoice charges
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code> is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.</p>
                    * no_action - <p class="mb-2">Retain as unbilled
                    If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">no_action</code> is chosen, charges are added to the resumption invoice.</p>
                  enum:
                  - no_action
                  - invoice
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    pause_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>
                        state, it is the date/time when the subscription was paused.</p>
                      example: null
                    resume_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
                      example: null
                    skip_billing_cycles:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Number of billing cycles this subscription should be paused. The subscription resumes after the paused billing cycles end.
                      minimum: 1
                      example: null
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/advance_invoice_estimate:
    post:
      summary: Advance invoice estimate
      description: |
        This API is used to generate an invoice estimate for preview. Estimate details include the number of billing cycles to be invoiced in advance, the number of billing cycles in one interval, advance invoicing schedules, and so on.
      operationId: advance_invoice_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                terms_to_charge:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |-
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type = immediate</code>: the number of future billing cycles to be invoiced in advance. The invoicing is done for the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a> of the subscription if that is less than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>.</li>
                    <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type = fixed_intervals</code>: The number of future billing cycles in one <a href="/docs/api/advance_invoice_schedules">interval</a>. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles">remaining_billing_cycles</a> of the subscription.
                    .</li>
                    </ul>
                  minimum: 1
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the charge should be invoiced immediately or added to <a href="/docs/api/unbilled_charges"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unbilled_charges</code></a>.
                    Applicable only when <a href="/docs/api/subscriptions/charge-future-renewals#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediate</code>
                    .</p>
                  example: null
                schedule_type:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The type of advance invoice or advance invoicing schedule.</p>
                    * immediate - <p class="mb-2">Charge immediately for the number of billing cycles specified by <a href="/docs/api/subscriptions/charge-future-renewals#terms_to_charge"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code></a>
                    .</p>
                    * specific_dates - <p class="mb-2">Charge on <a href="/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date">specific dates</a>.
                    For each date, specify the <a href="/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge">number of billing cycles</a>
                    to charge for. Up to 5 dates can be configured.</p>
                    * fixed_intervals - <p class="mb-2">Charge at fixed intervals of time. Specify the <a href="/docs/api/subscriptions/charge-future-renewals#terms_to_charge">number of billing cycles</a>
                    that constitute an interval and the number of <a href="/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal">days before each interval</a>
                    that the invoice should be generated. Also specify <a href="/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_end_schedule_on">when the schedule should end</a>
                    .</p>
                  enum:
                  - immediate
                  - specific_dates
                  - fixed_intervals
                  example: null
                fixed_interval_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for fixed_interval_schedule
                  properties:
                    number_of_occurrences:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a>
                        of the subscription.  This parameter is applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">after_number_of_intervals</code></p>
                      minimum: 1
                      example: null
                    days_before_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before each interval that advance invoices are generated.
                      minimum: 1
                      example: null
                    end_schedule_on:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies when the schedule should end.</p>
                        * after_number_of_intervals - <p class="mb-2">Advance invoices are generated a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specified number of times</code></p>
                        * subscription_end - <p class="mb-2">Advance invoices are generated for as long as the subscription is active.</p>
                        * specific_date - <p class="mb-2">End the advance invoicing schedule on a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific date</code>
                        .</p>
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                        .</p>
                      example: null
                  example: null
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for specific_dates_schedule
                  properties:
                    terms_to_charge:
                      type: array
                      description: |-
                        <p class="mb-2">The number of billing cycles to charge for, on the date specified. Applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is specific_dates.</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: |-
                        <p class="mb-2">The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_dates</code>
                        .</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              fixed_interval_schedule:
                style: deepObject
                explode: true
              specific_dates_schedule:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /estimates/create_subscription:
    post:
      summary: Create subscription estimate
      description: |-
        <div class="api-description"><p class="mb-2">Generates an estimate for the &#x27;create subscription&#x27; operation. This is similar to the <a href="/docs/api/v2/pcv-1/subscriptions/create-a-subscription">Create Subscription</a> API but no subscription will be created, only an estimate for this operation is created.</p><p class="mb-2">In the response,</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><strong class="font-semibold">estimate.subscription_estimate</strong> has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><strong class="font-semibold">estimate.invoice_estimate</strong> has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation.</p>
        </li>
        </ul><p class="mb-2"><strong class="font-semibold">estimate.next_invoice_estimate</strong>
        has details of the invoice that will be generated on the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation and this subscription has next billing.</p><div class="alert alert-info"><p class="mb-2">If the subscription is created in <strong class="font-semibold">trial/future</strong>
        states, <em class="italic">estimate.invoice_estimate</em>
        will not be present as no immediate invoice would be generated. However, <em class="italic">estimate.next_invoice_estimate</em>
        will be returned which is a preview of the invoice that would be generated at a later date when the subscription becomes &#x27;active&#x27;.</p></div><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">estimate.unbilled_charge_estimates</strong> has details of the unbilled charges. This is returned only if <em class="italic">invoice_immediately</em> is set as false. But this is not applicable for the &#x27;Subscription renewal estimate&#x27; operation.</li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</strong></p><p class="mb-2">Set the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer[taxability]</code>
        attribute as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
        and provide any other necessary parameters to compute taxes. Otherwise tax is exempted for the estimate.</p></div><h4>Related Tutorial</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <a href="https://www.chargebee.com/tutorials/in-app-checkout-page-using-estimate-api-example.html">Check out this tutorial for when and how to use create subscription estimate API</a>
        </li>
        </ul></div>
      operationId: create_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
                  example: null
                client_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  maxLength: 50
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                        is passed, the subscription will be activated immediately.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                        <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                        <li class="text-base leading-relaxed">The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.</li>
                        </ul>
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    free_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
                      minimum: 1
                      example: null
                    free_period_unit:
                      type: string
                      deprecated: false
                      description: |
                        The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit)
                        attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)
                        chosen.
                        \* year -

                        Charge based on year(s)
                        \* day -

                        Charge based on day(s)
                        \* month -

                        Charge based on month(s)
                        \* week -

                        Charge based on week(s)
                      enum:
                      - day
                      - week
                      - month
                      - year
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                    trial_end_action:
                      type: string
                      deprecated: false
                      description: |
                        Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                        has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
                        \* activate_subscription -

                        The subscription activates and charges are raised for non-metered items.
                        \* cancel_subscription -

                        The subscription cancels.
                        \* plan_default -

                        The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                        at the time when the trial ends, takes effect.
                        \* site_default -

                        This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                        at the time when the trial ends, takes effect.
                      enum:
                      - site_default
                      - plan_default
                      - activate_subscription
                      - cancel_subscription
                      example: null
                  required:
                  - plan_id
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |-
                        <p class="mb-2">Specifies if the customer is liable for tax</p>
                        * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
                        <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
                        </ul>
                        * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
                        In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
                      enum:
                      - taxable
                      - exempt
                      example: null
                    entity_code:
                      type: string
                      deprecated: false
                      description: |
                        The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                        \* med2 -

                        US Medical Device Excise Tax with taxable sales tax
                        \* med1 -

                        US Medical Device Excise Tax with exempt sales tax
                        \* b -

                        State government
                        \* c -

                        Tribe/Status Indian/Indian Band
                        \* a -

                        Federal government
                        \* f -

                        Religious organization
                        \* g -

                        Resale
                        \* d -

                        Foreign diplomat
                        \* e -

                        Charitable or benevolent organization
                        \* j -

                        Direct pay permit
                        \* k -

                        Direct mail
                        \* h -

                        Commercial agricultural production
                        \* i -

                        Industrial production/manufacturer
                        \* n -

                        Local government
                        \* l -

                        Other or custom
                        \* m -

                        Educational organization
                        \* r -

                        Non-resident
                        \* p -

                        Commercial aquaculture
                        \* q -

                        Commercial Fishery
                      enum:
                      - a
                      - b
                      - c
                      - d
                      - e
                      - f
                      - g
                      - h
                      - i
                      - j
                      - k
                      - l
                      - m
                      - "n"
                      - p
                      - q
                      - r
                      - med1
                      - med2
                      example: null
                    exempt_number:
                      type: string
                      deprecated: false
                      description: |
                        Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
                        .
                      maxLength: 100
                      example: null
                    exemption_details:
                      type: array
                      deprecated: false
                      description: |
                        Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                        To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)
                        .
                      items:
                        example: null
                      example: null
                    customer_type:
                      type: string
                      deprecated: false
                      description: |
                        Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                        \* business -

                        When the purchase is made at a place of business
                        \* residential -

                        When the purchase is made by a customer for home use
                        \* industrial -

                        When the purchase is made by an industrial business
                        \* senior_citizen -

                        When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
                      enum:
                      - residential
                      - business
                      - senior_citizen
                      - industrial
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                        status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        )</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the related tax field
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /estimates/create_invoice:
    post:
      summary: Create invoice estimate
      description: |
        Generates an estimate for the 'create an invoice' operation. This is similar to the [Create an invoice](/docs/api/v2/pcv-1/invoices/create-an-invoice) API, but the invoice will not be generated. Only an estimate for this operation is created.

        In the response,

        * **estimate.invoice_estimate** has details of the invoice that will be generated immediately.
      operationId: create_invoice_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the invoice amount.
                  maxLength: 3
                  example: null
                invoice_note:
                  type: string
                  deprecated: false
                  description: |
                    A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes)
                    for the invoice are displayed on the PDF invoice sent to the customer.
                  maxLength: 2000
                  example: null
                remove_general_note:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    to remove the <a href="https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes" target="_blank"><strong class="font-semibold">general note</strong></a>
                    from this invoice.</p>
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                authorization_transaction_id:
                  type: string
                  deprecated: false
                  description: |
                    Authorization transaction to be captured.
                  maxLength: 40
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source to be used for this payment.
                  maxLength: 40
                  example: null
                auto_collection:
                  type: string
                  deprecated: false
                  description: |
                    The customer level auto collection will be override if specified.
                    \* on -

                    Whenever an invoice is created, an automatic attempt will be made to charge.
                    \* off -

                    Whenever an invoice is created as payment due.
                  enum:
                  - "on"
                  - "off"
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</p>
                  example: null
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.
                      maxLength: 50
                      example: null
                    subscription_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.(not applicable for consolidated invoice)
                      maxLength: 50
                      example: null
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase Order Number for this invoice.
                      maxLength: 100
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the addon starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the addon ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).
                        Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    taxable:
                      type: array
                      description: |
                        The amount to be charged is taxable or not.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    tax_profile_id:
                      type: array
                      description: |
                        Tax profile of the charge.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_tax_code:
                      type: array
                      description: |
                        The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    hsn_code:
                      type: array
                      description: |
                        The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                        to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                        * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                        * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    taxjar_product_code:
                      type: array
                      description: |
                        The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                          \* retail -

                          Transaction is a sale to an end user
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date_from:
                      type: array
                      description: |
                        The time when the service period for the charge starts.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    date_to:
                      type: array
                      description: |
                        The time when the service period for the charge ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                notes_to_remove:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for notes_to_remove
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |-
                          <p class="mb-2">Type of entity to which the <a href="/docs/api/invoices/invoice-object#notes">note</a>
                          belongs. To remove the general note, use the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remove_general_note</code>
                          parameter.</p>
                          * plan - <p class="mb-2">Entity that represents a plan.</p>
                          * addon - <p class="mb-2">Entity that represents an addon.</p>
                          * addon_item_price - <p class="mb-2">Indicates that this line item is based on addon Item Price</p>
                          * plan_item_price - <p class="mb-2">Indicates that this line item is based on plan Item Price</p>
                          * customer - <p class="mb-2">Entity that represents a customer.</p>
                          * subscription - <p class="mb-2">Entity that represents a subscription of customer.</p>
                          * charge_item_price - <p class="mb-2">Indicates that this line item is based on charge Item Price</p>
                          * coupon - <p class="mb-2">Entity that represents a coupon.</p>
                        enum:
                        - plan
                        - addon
                        - customer
                        - subscription
                        - coupon
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the related tax field
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              notes_to_remove:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /subscriptions/{subscription-id}/cancel_subscription_estimate:
    post:
      summary: Cancel subscription estimate
      description: |
        Generates an estimate for the 'cancel subscription' operation. This is similar to the [Cancel a subscription](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription) API, but the subscription will not be cancelled. Only an estimate for this operation is created.

        In the response,

        * **estimate.subscription_estimate** has the subscription details.
        * **estimate.invoice_estimate** has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation.
        * **estimate.credit_note_estimates\[\]** has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.
        * **estimate.unbilled_charge_estimates** has details of the unbilled charges.
      operationId: cancel_subscription_estimate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                cancel_option:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Determines when to cancel the subscription.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">This parameter is not applicable.</p>
                    * end_of_billing_term - <p class="mb-2">This is used to cancel a subscription either at the end of the advance term, if it&#x27;s billed for future renewals or at the end of its current billing cycle</p>
                    * end_of_term - <p class="mb-2">This is used to cancel a subscription at the end of the current billing cycle</p>
                    * immediately - <p class="mb-2">This is used to cancel the subscription with immediate effect</p>
                    * specific_date - <p class="mb-2">This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code></p>
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - end_of_billing_term
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">(Deprecated)</strong> Use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> instead.
                    Applicable only when the subscription does not have <a href="/docs/api/contract_terms">contract terms</a>.
                    Set this to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> changes to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                  example: null
                cancel_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies the date and time when the subscription should be canceled. Do not use this parameter when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">end_of_term</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>. Specifies the date and time to cancel the subscription and contract term.</p>
                    <h5>Backdating</h5>
                    <p class="mb-2">You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/backdating.html" target="_blank">Backdating</a> is enabled for subscription cancellation.</li>
                    <li class="text-base leading-relaxed">The current date does not exceed the <a href="https://www.chargebee.com/docs/1.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing" target="_blank">backdating limit configured in Chargebee Billing</a>.</li>
                    <li class="text-base leading-relaxed">The date is on or after the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</li>
                    <li class="text-base leading-relaxed">The date is on or after the most recent change involving:
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Addition/change/removal of plan or addon item prices.</li>
                    <li class="text-base leading-relaxed">Addition of charge item prices.</li>
                    </ul>
                    </li>
                    <li class="text-base leading-relaxed">The date is not more than one billing period into the past. For example, if the plan&#x27;s billing period is two months and today is April 14, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code> cannot be earlier than February 14.</li>
                    </ul>
                  example: null
                credit_option_for_current_term_charges:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle credits for current term charges when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle credits for current term charges when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * none - <p class="mb-2">No credits notes are created.</p>
                    * full - <p class="mb-2">Credits are issues for the full value of the current term charges.</p>
                    * prorate - <p class="mb-2">Prorated credits are issued.</p>
                  enum:
                  - none
                  - prorate
                  - full
                  example: null
                unbilled_charges_option:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle unbilled charges when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle unbilled charges when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * invoice - <p class="mb-2">An invoice is generated immediately with the unbilled charges.</p>
                    * delete - <p class="mb-2">The unbilled charges are deleted.</p>
                  enum:
                  - invoice
                  - delete
                  example: null
                account_receivables_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle past due invoices when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle past due invoices when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * no_action - <p class="mb-2">No action is taken.</p>
                    * write_off - <p class="mb-2">Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.
                    <em class="italic">Note: The credit note for the write-off is not included in the API response.</em></p>
                    * schedule_payment_collection - <p class="mb-2">Applies excess payments and refundable credits to past due invoices. If any amount remains and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">on</code>
                    , the remaining amount is automatically charged to the available payment method.</p>
                  enum:
                  - no_action
                  - schedule_payment_collection
                  - write_off
                  example: null
                refundable_credits_handling:
                  type: string
                  deprecated: false
                  description: |-
                    <h5>If the subscription does not have a contract term:</h5>
                    <p class="mb-2">Specifies how to handle refundable credits when canceling immediately (i.e., <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">immediately</code>). If not specified, the <a href="https://www.chargebee.com/docs/1.0/cancellations.html#configure-subscription-cancellation">site-level setting</a> is used.</p>
                    <h5>If the subscription has a contract term:</h5>
                    <p class="mb-2">Specifies how to handle refundable credits when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_cancel_option</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminate_immediately</code>. If not specified, the <a href="https://www.chargebee.com/docs/1.0/contract-terms.html#configuring-contract-terms">site-level setting</a> is used.</p>
                    * schedule_refund - <p class="mb-2">Refunds remaining credits after applying them to any past due invoices.</p>
                    * no_action - <p class="mb-2">No action is taken.</p>
                  enum:
                  - no_action
                  - schedule_refund
                  example: null
                contract_term_cancel_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.</p>
                    * terminate_immediately - <p class="mb-2">Cancels the subscription and contract term immediately. Sets the contract term&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminated</code> and collects any termination fee, if applicable.
                    To specify the termination fee, include a single object in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_items</code> array. If not specified, the <a href="/docs/api/contract_terms">default termination fee</a> is applied (if configured).</p>
                    * end_of_contract_term - <p class="mb-2">Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.</p>
                    * specific_date - <p class="mb-2">Cancels the subscription and contract term on the date specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code>. Sets <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.
                    <strong class="font-semibold">Note</strong>: Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this option for your <a href="https://www.chargebee.com/docs/1.0/sites-intro.html">Chargebee site</a>.</p>
                    * end_of_subscription_billing_term - <p class="mb-2">Cancels the subscription and contract term at the end of the current billing cycle. Sets <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.
                    <strong class="font-semibold">Note</strong>: Contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this option for your <a href="https://www.chargebee.com/docs/1.0/sites-intro.html">Chargebee site</a>.</p>
                  enum:
                  - terminate_immediately
                  - end_of_contract_term
                  - specific_date
                  - end_of_subscription_billing_term
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax</code>
                    configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">It is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel_at</code>.
                    .</li>
                    </ul>
                  example: null
                cancel_reason_code:
                  type: string
                  deprecated: false
                  description: |
                    Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**.
                    Must be passed if set as mandatory in the app. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |-
                        <p class="mb-2">The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the event-based addon that represents the termination fee.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The termination fee. In case it is quantity-based, this is the fee per unit.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        The service period of the termination fee-expressed in days-starting from the current date.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              event_based_addons:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: <p class="mb-2">Resource object representing estimate</p>
                required:
                - estimate
                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: []
  /quotes/{quote-id}/edit_one_time_quote:
    post:
      summary: Edit quote for one-time charges
      description: |
        Edits a quote. The quote must be for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) or [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon).

        To edit quotes created for subscriptions, use:

        * [​​Edit quote for new subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-a-new-subscription).
        * [Edit quote for updating a subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-updating-a-subscription).
      operationId: edit_quote_for_one-time_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this quote.
                  maxLength: 100
                  example: null
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the quote.
                  maxLength: 3
                  example: null
                coupon:
                  type: string
                  deprecated: false
                  description: |
                    The 'One Time' coupon to be applied.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period:
                      type: array
                      description: |-
                        <p class="mb-2">Specifies the service period of the addon in days. When the quote is converted, the <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_from</a></code>
                        is set to current date/time and <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_to</a></code>
                        is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">service_period</code>
                        days ahead of <code><a href="/docs/api/invoices/invoice-object#line_items">date_from</a></code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the one-time charge. The value is in [major units of the currency](/docs/api/getting-started).
                        Applicable only when multi-decimal pricing is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                          \* retail -

                          Transaction is a sale to an end user
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    service_period:
                      type: array
                      description: |
                        Service period for charge
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                required:
                - quote
                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: []
  /quotes/{quote-id}:
    get:
      summary: Retrieve a quote
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">Retrieves the quotes identified by the `number` specified in the URL.</p></div>
      operationId: retrieve_a_quote
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: Resource object representing quoted_ramp
                required:
                - quote
                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: []
  /quotes/update_subscription_quote:
    post:
      summary: Create quote for updating a subscription
      description: |
        Creates a quote for updating a subscription under the customer specified.

        To send this quote, use "[Send Email](https://www.chargebee.com/docs/quotes.html#other-quote-actions_send-email)" quote action in the Chargebee application.

        Based on the customer's reply, you can use [Update quote status](/docs/api/v2/pcv-1/quotes/update-quote-status) and [Convert a quote](/docs/api/v2/pcv-1/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.
      operationId: create_quote_for_updating_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    The quote name will be used as the pdf name of the quote.
                  maxLength: 100
                  example: null
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                replace_addon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing addons should be replaced with the ones that are being passed.
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">If the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changed_scheduled_at</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating must be enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is on or after the last date/time any of the product catalog items of the subscription were changed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    chosen for the site for calendar billing. Only applicable when using calendar billing.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the coupon as a List. Coupon Codes can also be passed.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing coupons should be replaced with the ones that are being passed.
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.</p>
                    * end_of_term - <p class="mb-2">The change is carried out at the end of the current billing cycle of the subscription.</p>
                    * specific_date - <p class="mb-2">The change is carried out as of the date specified under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    .</p>
                    * immediately - <p class="mb-2">The change is carried out immediately.</p>
                  enum:
                  - immediately
                  - specific_date
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                    , then set the date/time at which the subscription change is to happen or has happened. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Backdating must be enabled for subscription change operations.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Only the following changes can be backdated:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after the last date/time any of the following changes were made:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription&#x27;s plan is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February..</p>
                    </li>
                    </ul>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    parameter does not apply to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_collection</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                    , and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">po_number</code>
                    ; these parameters take effect <strong class="font-semibold">immediately</strong>
                    when scheduling a subscription update.</p></div>
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Applicable for 'Active' \& 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
                    **Note**:
                    Specifying this value as 'false' has no impact on the default behaviour.
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Represents the plan quantity for this subscription.
                      minimum: 1
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The new start date of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscription. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscriptions.</p>
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        , or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.
                        Also, the value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.
                        <strong class="font-semibold">Note</strong>:
                        This parameter can be backdated (set to a value in the past) only when the subscription is in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>
                        is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                        status.</p>
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  required:
                  - id
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. To update this value, redo the complete addon set using <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">replace_addon_list</code></a>.
                        (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        .)</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                required:
                - quote
                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: []
  /quotes/create_for_onetime_charges:
    post:
      summary: Create quote for one-time charges
      description: |
        Creates a quote for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) and [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon). This is applicable only for one-time payment. Recurring charges are not permitted in this quote; use [Create quote for a new subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-a-new-subscription) or [Create quote for updating a subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-updating-a-subscription) instead.

        To send this quote, use "[Send Email](https://www.chargebee.com/docs/quotes.html#other-quote-actions_send-email)" quote action in the Chargebee application.

        Based on the customer's reply, you can use [Update quote status](/docs/api/quotes/update-quote-status) and [Convert a quote](/docs/api/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.
      operationId: create_quote_for_one-time_charges
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    The quote name will be used as the pdf name of the quote.
                  maxLength: 100
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the customer for which the quote needs to be created.
                  maxLength: 50
                  example: null
                po_number:
                  type: string
                  deprecated: false
                  description: |
                    Purchase Order Number for this quote.
                  maxLength: 100
                  example: null
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the quote.
                  maxLength: 3
                  example: null
                coupon:
                  type: string
                  deprecated: false
                  description: |
                    The 'One Time' coupon to be applied.
                  maxLength: 100
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period:
                      type: array
                      description: |-
                        <p class="mb-2">Specifies the service period of the addon in days. When the quote is converted, the <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_from</a></code>
                        is set to current date/time and <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_to</a></code>
                        is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">service_period</code>
                        days ahead of <code><a href="/docs/api/invoices/invoice-object#line_items">date_from</a></code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    amount:
                      type: array
                      description: |
                        The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the amount for the one-time charge. The value is in [major units of the currency](/docs/api/getting-started).
                        Applicable only when multi-decimal pricing is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this charge
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    avalara_sale_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                          integration.
                          \* consumed -

                          Transaction is for an item that is consumed directly
                          \* vendor_use -

                          Transaction is for an item that is subject to vendor use tax
                          \* wholesale -

                          Transaction is a sale to another company that will resell your product or service to another consumer
                          \* retail -

                          Transaction is a sale to an end user
                        enum:
                        - wholesale
                        - retail
                        - consumed
                        - vendor_use
                        example: null
                      example: null
                    avalara_transaction_type:
                      type: array
                      description: |
                        Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    avalara_service_type:
                      type: array
                      description: |
                        Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                        integration.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    service_period:
                      type: array
                      description: |
                        Service period for charge
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                required:
                - quote
                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: []
  /quotes/{quote-id}/update_status:
    post:
      summary: Update quote status
      description: |
        Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.
      operationId: update_quote_status
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                status:
                  type: string
                  deprecated: false
                  description: |
                    Status to update for the quote.
                    \* accepted -

                    Accepted.
                    \* closed -

                    Closed
                    \* declined -

                    Declined.
                  enum:
                  - accepted
                  - declined
                  - proposed
                  - voided
                  - closed
                  example: null
                comment:
                  type: string
                  deprecated: false
                  description: |
                    An internal [comment](/docs/api/comments)
                    to be added for this operation, to the quote. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)
                    or any document such as the [Quote PDF](/docs/api/quotes/retrieve-quote-as-pdf)
                    .
                  maxLength: 300
                  example: null
              required:
              - status
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: Resource object representing quoted_ramp
                required:
                - quote
                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: []
  /customers/{customer-id}/create_subscription_quote:
    post:
      summary: Create quote for a new subscription
      description: |
        Creates a quote for a new subscription under the customer specified.

        To send this quote, use "[Send Email](https://www.chargebee.com/docs/1.0/quotes.html#other-quote-actions_send-email)" quote action in the Chargebee application.

        Based on the customer's reply, you can use [Update quote status](/docs/api/v2/pcv-1/quotes/update-quote-status) and [Convert a quote](/docs/api/v2/pcv-1/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.
      operationId: create_quote_for_a_new_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    The quote name will be used as the pdf name of the quote.
                  maxLength: 100
                  example: null
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the coupon as a List. Coupon Codes can also be passed.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                        is passed, the subscription will be activated immediately.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                        <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                        <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[start_date]</code> cannot be earlier than 14th February.</li>
                        </ul>
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  required:
                  - plan_id
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                        status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        )</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                required:
                - quote
                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: []
  /quotes/{quote-id}/quote_line_groups:
    get:
      summary: List quote line groups
      description: |
        This API retrieves all the quote line groups and lineitems for a quote.
      operationId: list_quote_line_groups
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        quote_line_group:
                          $ref: "#/components/schemas/QuoteLineGroup"
                          description: Resource object representing quote_line_group
                      required:
                      - quote_line_group
                      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: []
  /quotes/{quote-id}/edit_update_subscription_quote:
    post:
      summary: Edit quote for updating a subscription
      description: |
        Edits a quote. This endpoint is for editing quotes that are for updating a subscription. To edit a quote for a new subscription, use [Edit quote for a new subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-a-new-subscription).
      operationId: edit_quote_for_updating_a_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                replace_addon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing addons should be replaced with the ones that are being passed.
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles to <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank">invoice in advance</a>.
                    If a new term is started for the subscription due to this API call, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                    is inclusive of this new term. See description for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">force_term_reset</code>
                    parameter to learn more about when a subscription term is reset.</p>
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">If the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    <strong class="font-semibold">Note:</strong>
                    It is recommended not to pass this parameter along with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changed_scheduled_at</code>.
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reactivate_from</code>
                    can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Backdating must be enabled for subscription reactivation operations.</li>
                    <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</li>
                    <li class="text-base leading-relaxed">The date is on or after the last date/time any of the product catalog items of the subscription were changed.</li>
                    <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</li>
                    </ul>
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    chosen for the site for calendar billing. Only applicable when using calendar billing.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the coupon as a List. Coupon Codes can also be passed.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Should be true if the existing coupons should be replaced with the ones that are being passed.
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.</p>
                    * end_of_term - <p class="mb-2">The change is carried out at the end of the current billing cycle of the subscription.</p>
                    * specific_date - <p class="mb-2">The change is carried out as of the date specified under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    .</p>
                    * immediately - <p class="mb-2">The change is carried out immediately.</p>
                  enum:
                  - immediately
                  - specific_date
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                    , then set the date/time at which the subscription change is to happen or has happened. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                    can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Backdating must be enabled for subscription change operations.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Only the following changes can be backdated:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is on or after the last date/time any of the following changes were made:</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Changes in the recurring items or their prices.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">Addition of non-recurring items.</p>
                    </li>
                    <li class="text-base leading-relaxed">
                    <p class="mb-2">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription&#x27;s plan is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.
                    .</p>
                    </li>
                    </ul>
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Applicable for 'Active' \& 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
                    **Note**:
                    Specifying this value as 'false' has no impact on the default behaviour.
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Represents the plan quantity for this subscription.
                      minimum: 1
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The new start date of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscription. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        subscriptions.</p>
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        , or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>.
                        Also, the value must not be earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>.
                        <strong class="font-semibold">Note</strong>:
                        This parameter can be backdated (set to a value in the past) only when the subscription is in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end</code>
                        is backdated, the subscription immediately goes into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>
                        status.</p>
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  example: null
                billing_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the billing contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the billing contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* valid -

                        Address was validated successfully.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
                        Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
                        ).</p>
                        <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
                        in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
                        the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
                        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
                        That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
                        The first two characters of the VAT number in such a case is
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
                        by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
                        Set
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
                        to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
                        for such cases.</p>
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |-
                        <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
                        is applicable. This field is applicable only when Australian GST is configured for your site.</p>
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. To update this value, redo the complete addon set using <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">replace_addon_list</code></a>.
                        (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        .)</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                required:
                - quote
                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: []
  /quotes/{quote-id}/extend_expiry_date:
    post:
      summary: Extend expiry date
      description: |
        Can be used to extend the expiry date of a quote.
      operationId: extend_expiry_date
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                valid_till:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quote will be valid till this date. After this date quote will be marked as closed.
                  example: null
              required:
              - valid_till
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: Resource object representing quoted_ramp
                required:
                - quote
                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: []
  /quotes/{quote-id}/edit_create_subscription_quote:
    post:
      summary: Edit quote for a new subscription
      description: |
        Edits a quote. This endpoint is for quotes that are for new subscriptions. To edit a quote that is for updating a subscription, use [Edit quote for updating a subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-updating-a-subscription).
      operationId: edit_quote_for_a_new_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Notes specific to this quote that you want customers to see on the quote PDF.
                  maxLength: 10000
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Quotes will be valid till this date. After this quote will be marked as closed.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
                  minimum: 0
                  example: null
                mandatory_addons_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)
                    .
                  minimum: 1
                  example: null
                billing_alignment_mode:
                  type: string
                  deprecated: false
                  description: |
                    Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)
                    for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
                    \* delayed -

                    Subscription period will be aligned with the configured billing date at the next renewal.
                    \* immediate -

                    Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..
                  enum:
                  - immediate
                  - delayed
                  example: null
                coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the coupon as a List. Coupon Codes can also be passed.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                    plan_id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      maxLength: 100
                      example: null
                    plan_quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        Plan quantity for this subscription
                      minimum: 1
                      example: null
                    plan_quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    plan_unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    plan_unit_price_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    setup_fee:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      minimum: 0
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**
                        is passed, the subscription will be activated immediately.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
                        <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
                        <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[start_date]</code> cannot be earlier than 14th February.</li>
                        </ul>
                      example: null
                    offline_payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                        \* uk_automated_bank_transfer -

                        UK Automated Bank Transfer
                        \* us_automated_bank_transfer -

                        US Automated Bank Transfer
                        \* boleto -

                        Boleto
                        \* no_preference -

                        No Preference
                        \* sepa_credit -

                        SEPA Credit
                        \* jp_automated_bank_transfer -

                        JP Automated Bank Transfer
                        \* mx_automated_bank_transfer -

                        MX Automated Bank Transfer
                        \* bank_transfer -

                        Bank Transfer
                        \* ach_credit -

                        ACH Credit
                        \* custom -

                        Custom
                        \* eu_automated_bank_transfer -

                        EU Automated Bank Transfer
                        \* cash -

                        Cash
                        \* check -

                        Check
                      enum:
                      - no_preference
                      - cash
                      - check
                      - bank_transfer
                      - ach_credit
                      - sepa_credit
                      - boleto
                      - us_automated_bank_transfer
                      - eu_automated_bank_transfer
                      - uk_automated_bank_transfer
                      - jp_automated_bank_transfer
                      - mx_automated_bank_transfer
                      - custom
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
                        or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
                        .</p>
                      maximum: 100
                      minimum: 1
                      example: null
                  required:
                  - plan_id
                  example: null
                shipping_address:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_address
                  properties:
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the contact.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the contact.
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address.
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        The company name.
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        The phone number.
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        The name of the city.
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        is provided.</p>
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                        .
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                        .</p>
                        <p class="mb-2"><strong class="font-semibold">Note</strong>:
                        If you enter an invalid country code, the system will return an error.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                      maxLength: 50
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                        \* valid -

                        Address was validated successfully.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Action to be taken when the contract term completes.</p>
                        * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                        * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                        </ul>
                        * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |-
                        <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                        , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                      example: null
                  example: null
                addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |-
                        <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                        <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                        <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                        <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                        </ul></div>
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">When <a href="http://chargebee.com/docs/price-override.html " target="_blank">price overriding</a>
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value <a href="/docs/api/v2/pcv-1/addons/addon-object#price" target="_blank">set for the addon</a>
                        is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
                        Provide the value as a decimal string in major units of the currency. Can be provided only when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |-
                        <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                        status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                        )</p>
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        A unique 'id' used to identify the addon.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](http://chargebee.com/docs/price-override.html )
                        is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)
                        is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_in_days:
                      type: array
                      description: |
                        Defines service period of the addon in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 4000
                        minimum: 1
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which this addon will be charged.
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                    charge_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the non-recurring addon will be charged.
                          \* on_event -

                          Charge for the addon will be applied on the occurrence of a specified event.
                          \* immediately -

                          Charges for the addon will be applied immediately.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              addons:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                required:
                - quote
                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: []
  /quotes:
    get:
      summary: List quotes
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">List all quotes.</p></div>
      operationId: list_quotes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\*\\\\\\\*deleted\\\\\\\*\\\\\\\* ' attribute will be '\\\\\\\*\\\\\\\*true\\\\\\\*\\\\\\\* '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          The quote number. Acts as a identifier for quote and typically generated sequentially.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "123"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "123"
          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: customer_id
        in: query
        description: |
          optional, string filter

          The identifier of the customer this quote belongs to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *customer_id\[is\] = "4gmiXbsjdm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 4gmiXbsjdm
          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: subscription_id
        in: query
        description: |
          optional, string filter

          To filter based on subscription_id.
          NOTE: Not to be used if *consolidated invoicing*
          feature is enabled.
          **Supported operators :**
          is, is_not, starts_with, is_present, in, not_in

          **Example →**
          *subscription_id\[is\] = "4gmiXbsjdm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 4gmiXbsjdm
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Current status of this quote. Possible values are : open, accepted, declined, invoiced, closed.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is_not\] = "open"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: open
          properties:
            is:
              type: string
              description: |
                \* \`open\` - Open \* \`accepted\` - Accepted. \* \`declined\` - Declined. \* \`invoiced\` - Invoiced \* \`closed\` - Closed \* \`pending_approval\` - Pending Approval \* \`approval_rejected\` - Approval Rejected \* \`proposed\` - Proposed. \* \`voided\` - Voided. \* \`expired\` - Expired
              enum:
              - open
              - accepted
              - declined
              - invoiced
              - closed
              - pending_approval
              - approval_rejected
              - proposed
              - voided
              - expired
              example: null
            is_not:
              type: string
              description: |
                \* \`open\` - Open \* \`accepted\` - Accepted. \* \`declined\` - Declined. \* \`invoiced\` - Invoiced \* \`closed\` - Closed \* \`pending_approval\` - Pending Approval \* \`approval_rejected\` - Approval Rejected \* \`proposed\` - Proposed. \* \`voided\` - Voided. \* \`expired\` - Expired
              enum:
              - open
              - accepted
              - declined
              - invoiced
              - closed
              - pending_approval
              - approval_rejected
              - proposed
              - voided
              - expired
              example: null
            in:
              type: string
              description: |
                \* \`open\` - Open \* \`accepted\` - Accepted. \* \`declined\` - Declined. \* \`invoiced\` - Invoiced \* \`closed\` - Closed \* \`pending_approval\` - Pending Approval \* \`approval_rejected\` - Approval Rejected \* \`proposed\` - Proposed. \* \`voided\` - Voided. \* \`expired\` - Expired
              enum:
              - open
              - accepted
              - declined
              - invoiced
              - closed
              - pending_approval
              - approval_rejected
              - proposed
              - voided
              - expired
              pattern: "^\\[(open|accepted|declined|invoiced|closed|pending_approval|approval_rejected|proposed|voided|expired)(,(open|accepted|declined|invoiced|closed|pending_approval|approval_rejected|proposed|voided|expired))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`open\` - Open \* \`accepted\` - Accepted. \* \`declined\` - Declined. \* \`invoiced\` - Invoiced \* \`closed\` - Closed \* \`pending_approval\` - Pending Approval \* \`approval_rejected\` - Approval Rejected \* \`proposed\` - Proposed. \* \`voided\` - Voided. \* \`expired\` - Expired
              enum:
              - open
              - accepted
              - declined
              - invoiced
              - closed
              - pending_approval
              - approval_rejected
              - proposed
              - voided
              - expired
              pattern: "^\\[(open|accepted|declined|invoiced|closed|pending_approval|approval_rejected|proposed|voided|expired)(,(open|accepted|declined|invoiced|closed|pending_approval|approval_rejected|proposed|voided|expired))*\\\
                ]$"
              example: null
      - name: date
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Creation date of the quote. Typically this is the date on which quote is generated.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *date\[after\] = "1435054328"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435054328"
          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
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              example: null
            desc:
              type: string
              enum:
              - date
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        quote:
                          $ref: "#/components/schemas/Quote"
                          description: <p class="mb-2">Resource object representing
                            quote</p>
                        quoted_subscription:
                          $ref: "#/components/schemas/QuotedSubscription"
                          description: <p class="mb-2">Resource object representing
                            quoted_subscription</p>
                        quoted_ramp:
                          $ref: "#/components/schemas/QuotedRamp"
                          description: Resource object representing quoted_ramp
                      required:
                      - quote
                      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: []
  /quotes/{quote-id}/pdf:
    post:
      summary: Retrieve quote as PDF
      description: |
        Retrieves the quote as a PDF. The returned URL is secure, allows download and expires in 60 minutes.
      operationId: retrieve_quote_as_pdf
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                consolidated_view:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    When true, the quote PDF has summary of all charges on the quote. When false, the quote PDF has a detailed view of charges grouped by charge event. This parameter does not affect one-time quotes.
                  example: null
                disposition_type:
                  type: string
                  default: attachment
                  deprecated: false
                  description: |
                    Determines the pdf should be rendered as inline or attachment in the browser.
                    \* attachment -

                    PDF is rendered as attachment in the browser
                    \* inline -

                    PDF is rendered as inline in the browser
                  enum:
                  - attachment
                  - inline
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  download:
                    $ref: "#/components/schemas/Download"
                    description: <p class="mb-2">Resource object representing download</p>
                required:
                - download
                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: []
  /quotes/{quote-id}/convert:
    post:
      summary: Convert a quote
      description: |
        This API is to convert a quote to an invoice.
      operationId: convert_a_quote
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |-
                    <p class="mb-2">The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. When not provided, the value is the same as current date. Moreover, if the invoice is created as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>
                    , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxes</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item_taxes</code>
                    are computed based on the tax configuration as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code>.
                    When passing this parameter, the following prerequisites must be met:</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> must be in the past.</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_date</code> is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.</li>
                    <li class="text-base leading-relaxed">The date is not earlier than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quoted_subscription.start_date</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quoted_subscription.changes_scheduled_at</code> (whichever is applicable).</li>
                    <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code> must be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                    .</li>
                    </ul>
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to <a href="https://www.chargebee.com/docs/unbilled-charges.html" target="_blank">unbilled charges</a>.
                    The default value is as per the <a href="https://www.chargebee.com/docs/unbilled-charges.html#configuration" target="_blank">site settings</a>
                    .</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                    <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_immediately</code>
                    only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.</p></div>
                    <p class="mb-2">.</p>
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Applicable only for create subscription quote.
                      maxLength: 50
                      example: null
                    auto_collection:
                      type: string
                      deprecated: false
                      description: |
                        Applicable only for create subscription quote.
                        \* off -

                        Automatic collection of charges will not be made for this subscription. Use this for offline payments.
                        \* on -

                        Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
                      enum:
                      - "on"
                      - "off"
                      example: null
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: Resource object representing quoted_ramp
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: <p class="mb-2">Resource object representing customer</p>
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: <p class="mb-2">Resource object representing subscription</p>
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: <p class="mb-2">Resource object representing invoice</p>
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: <p class="mb-2">Resource object representing credit_note</p>
                  unbilled_charges:
                    type: array
                    description: <p class="mb-2">Resource object representing unbilled_charge</p>
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                required:
                - customer
                - quote
                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: []
  /quotes/{quote-id}/delete:
    post:
      summary: Delete a quote
      description: |
        Delete an existing quote using this API.
      operationId: delete_a_quote
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: quote-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/quote-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  deprecated: false
                  description: |
                    Reason for deleting this transaction. This comment will be added to the associated entity.
                  maxLength: 300
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: <p class="mb-2">Resource object representing quote</p>
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: <p class="mb-2">Resource object representing quoted_subscription</p>
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: <p class="mb-2">Resource object representing quoted_charge</p>
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: Resource object representing quoted_ramp
                required:
                - quote
                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: []
  /plans/{plan-id}/unarchive:
    post:
      summary: Unarchive a plan
      description: |-
        <div class="api-description"><p class="mb-2">This endpoint unarchives a specific plan which was <code><a href="/docs/api/v2/pcv-1/plans/plan-object#status">archived</a></code>
        earlier.</p></div>
      operationId: unarchive_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: plan-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/plan-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
  /plans/{plan-id}/delete:
    post:
      summary: Delete a plan
      description: |-
        <div class="api-description"><p class="mb-2">Deletes or archives a plan. This endpoint behaves differently based on the scenarios listed below:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">When the plan has subscriptions/invoices linked, it is not deleted. Instead, it is moved to the <code><a href="/docs/api/v2/pcv-1/plans/plan-object#status">archived</a></code> state. Subscriptions already on it continue to renew. However, until the plan is unarchived,
        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">No other subscription can use the plan</li>
        <li class="text-base leading-relaxed">You cannot update the plan</li>
        </ul>
        </li>
        <li class="text-base leading-relaxed">When the plan does not have any subscriptions or invoices linked to it, the endpoint permanently deletes the plan from your Chargebee site. You cannot undo this action.</li>
        </ul></div>
      operationId: delete_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: plan-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/plan-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
  /plans/copy:
    post:
      summary: Copy a plan
      description: "Creates a plan in this site by copying its configurations from\
        \ another site. Copying of archived plans is not supported.  \n**Note:**\n\
        The attribute *tax_profile_id*\nis not copied. In effect, if the plan is taxable,\
        \ it will be mapped to the *Primary*\ntax profile.\n"
      operationId: copy_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                from_site:
                  type: string
                  deprecated: false
                  description: |
                    Your Chargebee site name having the plan to be copied.
                    **Note:**
                    Unless you are copying from a twin site (acme \& acme-test are twin sites), [contact support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)
                    to have this allow-listed.
                  maxLength: 50
                  example: null
                id_at_from_site:
                  type: string
                  deprecated: false
                  description: |
                    Id of the plan to be copied. The new plan created in this site will have the same Id.
                  maxLength: 100
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id of copied plan in this site.
                  maxLength: 100
                  example: null
                for_site_merging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If copy action is performed as part of Chargebee site merge action, pass the value as true.
                  example: null
              required:
              - from_site
              - id_at_from_site
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
  /plans:
    get:
      summary: List plans
      description: "<div class=\"api-description\"><p class=\"mb-2\">This API fetches\
        \ all the <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code>\
        \ and <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">archived</code>\
        \ plans. If the limit parameter is not set, it will return upto 10 plans.</p></div>"
      operationId: list_plans
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          A unique ID for your system to identify the plan.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "Enterprise"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Enterprise
          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: name
        in: query
        description: |
          optional, string filter

          The display name used in web interface for identifying the plan.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[is\] = "plan_enterprise"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: plan_enterprise
          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: price
        in: query
        description: |
          optional, in cents filter

          The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)
          .
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *price\[gte\] = "1200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1200"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: period
        in: query
        description: |
          optional, integer filter

          Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *period\[lte\] = "3"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "3"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: period_unit
        in: query
        description: |
          optional, enumerated string filter

          Defines billing frequency in association with billing period. Possible values are : day, week, month, year.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *period_unit\[is\] = "month"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: month
          properties:
            is:
              type: string
              description: |
                \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
              enum:
              - day
              - week
              - month
              - year
              example: null
            is_not:
              type: string
              description: |
                \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
              enum:
              - day
              - week
              - month
              - year
              example: null
            in:
              type: string
              description: |
                \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
              enum:
              - day
              - week
              - month
              - year
              pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
              enum:
              - day
              - week
              - month
              - year
              pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$"
              example: null
      - name: trial_period
        in: query
        description: |
          optional, integer filter

          The free time window for your customer to try your product.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between, is_present

          **Example →**
          *trial_period\[lt\] = "14"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "14"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: trial_period_unit
        in: query
        description: |
          optional, enumerated string filter

          Time unit for the trial period. Possible values are : day, month.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *trial_period_unit\[is\] = "day"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: day
          properties:
            is:
              type: string
              description: |
                \* \`day\` - In days \* \`month\` - In months
              enum:
              - day
              - month
              example: null
            is_not:
              type: string
              description: |
                \* \`day\` - In days \* \`month\` - In months
              enum:
              - day
              - month
              example: null
            in:
              type: string
              description: |
                \* \`day\` - In days \* \`month\` - In months
              enum:
              - day
              - month
              pattern: "^\\[(day|month)(,(day|month))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`day\` - In days \* \`month\` - In months
              enum:
              - day
              - month
              pattern: "^\\[(day|month)(,(day|month))*\\]$"
              example: null
      - name: addon_applicability
        in: query
        description: |
          optional, enumerated string filter

          Indicates if all or only some addons are applicable with the plan. Possible values are : all, restricted.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *addon_applicability\[is\] = "all"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: all
          properties:
            is:
              type: string
              description: |
                \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
              enum:
              - all
              - restricted
              example: null
            is_not:
              type: string
              description: |
                \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
              enum:
              - all
              - restricted
              example: null
            in:
              type: string
              description: |
                \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
              enum:
              - all
              - restricted
              pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
              enum:
              - all
              - restricted
              pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
              example: null
      - name: giftable
        in: query
        description: |
          optional, boolean filter

          Specifies if the plan should be gifted or not. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *giftable\[is\] = "true"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "true"
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: pricing_model
        in: query
        description: |
          optional, enumerated string filter

          Defines how the recurring charges for the subscription is calculated. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *pricing_model\[is\] = "flat_fee"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: flat_fee
          properties:
            is:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              example: null
            is_not:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              example: null
            in:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              pattern: "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              pattern: "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\\
                ]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          The plan state. Possible values are : active, archived, deleted.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "active"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: active
          properties:
            is:
              type: string
              description: |
                \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
              enum:
              - active
              - archived
              - deleted
              example: null
            is_not:
              type: string
              description: |
                \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
              enum:
              - active
              - archived
              - deleted
              example: null
            in:
              type: string
              description: |
                \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[before\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: currency_code
        in: query
        description: |
          optional, string filter

          The currency code (ISO 4217 format) of the plan.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *currency_code\[is\] = "USD"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: USD
          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: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted**
          ' attribute will be '**true**
          '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        plan:
                          $ref: "#/components/schemas/Plan"
                          description: Resource object representing plan
                      required:
                      - plan
                      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: []
    post:
      summary: Create a plan
      description: |
        This endpoint creates a new plan based on the plan Id and plan name.
      operationId: create_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique ID for your system to identify the plan.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    The display name used in web interface for identifying the plan.
                  maxLength: 100
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description about the plan to show in the hosted pages \& customer portal.
                    **Note:**

                    If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
                  maxLength: 2000
                  example: null
                trial_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The free time window for your customer to try your product.
                  minimum: 1
                  example: null
                trial_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Time unit for the trial period.
                    \* month -

                    In months
                    \* day -

                    In days
                  enum:
                  - day
                  - month
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)
                    .
                    \* cancel_subscription -

                    The subscription cancels.
                    \* activate_subscription -

                    The subscription activates and charges are raised for non-metered items.
                    \* site_default -

                    The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                  enum:
                  - site_default
                  - activate_subscription
                  - cancel_subscription
                  example: null
                period:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  default: month
                  deprecated: false
                  description: |
                    Defines billing frequency in association with billing period.
                    \* month -

                    Charge based on month(s)
                    \* day -

                    Charge based on day(s)
                    \* week -

                    Charge based on week(s)
                    \* year -

                    Charge based on year(s)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                setup_cost:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    One-time setup fee charged as part of the first invoice.
                  minimum: 1
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The price of the plan when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
                    When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                    , it is the price per unit quantity of the plan. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                    is enabled. .</p>
                  maxLength: 39
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the plan.
                  maxLength: 3
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically.
                  minimum: 1
                  example: null
                pricing_model:
                  type: string
                  default: flat_fee
                  deprecated: false
                  description: |
                    Defines how the recurring charges for the subscription is calculated.
                    \* tiered -

                    There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                    \* per_unit -

                    A fixed price per unit quantity.
                    \* flat_fee -

                    A fixed price that is not quantity-based.
                    \* volume -

                    The per unit price is based on the tier that the total quantity falls in.
                    \* stairstep -

                    A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  enum:
                  - flat_fee
                  - per_unit
                  - tiered
                  - volume
                  - stairstep
                  example: null
                free_quantity:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.
                  minimum: 0
                  example: null
                free_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled. .
                  maxLength: 33
                  example: null
                addon_applicability:
                  type: string
                  default: all
                  deprecated: false
                  description: |
                    Indicates if all or only some addons are applicable with the plan.
                    \* all -

                    All addons are applicable with this plan.
                    \* restricted -

                    Only addons marked as 'applicable_addons' are applicable with the plan.
                  enum:
                  - all
                  - restricted
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic.
                  maxLength: 500
                  example: null
                enabled_in_hosted_pages:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true, allow checkout through plan specific hosted page URL for this plan.
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.
                  example: null
                taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
                    have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
                  example: null
                tax_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Tax profile of the plan.
                  maxLength: 50
                  example: null
                tax_code:
                  type: string
                  deprecated: false
                  description: |
                    The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                    .
                  maxLength: 50
                  example: null
                hsn_code:
                  type: string
                  deprecated: false
                  description: |
                    The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                    to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                    * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                    * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .
                  maxLength: 50
                  example: null
                taxjar_product_code:
                  type: string
                  deprecated: false
                  description: |
                    The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                    .
                  maxLength: 50
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* consumed -

                    Transaction is for an item that is consumed directly
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
                  maxLength: 100
                  example: null
                accounting_code:
                  type: string
                  deprecated: false
                  description: |
                    This field is to capture the Account code setup in your Accounting system for integration purposes only.
                  maxLength: 100
                  example: null
                accounting_category1:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category2:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category3:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                    .</li>
                    </ul>
                  maxLength: 100
                  example: null
                accounting_category4:
                  type: string
                  deprecated: false
                  description: |
                    Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

                    * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
                    * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product. .
                  maxLength: 100
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If enabled, charges for this plan/addon will be added to orders.
                  example: null
                shipping_frequency_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
                  minimum: 1
                  example: null
                shipping_frequency_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Defines the shipping frequency in association with shipping period.
                    \* month -

                    Ship based on month(s)
                    \* year -

                    Ship based on year(s)
                    \* day -

                    Ship based on day(s)
                    \* week -

                    Ship based on week(s)
                  enum:
                  - year
                  - month
                  - week
                  - day
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the plan. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                show_description_in_invoices:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the <code><a href="/docs/api/v2/pcv-1/plans/plan-object">plan.description</a></code>
                    should be shown on <a href="/docs/api/invoices/retrieve-invoice-as-pdf">invoice PDFs</a>.
                    If this Boolean is changed, only invoices generated (or <a href="https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">regenerated</a>
                    )after the change are affected; past invoices are not.</p>
                  example: null
                show_description_in_quotes:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)
                    should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
                    If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
                  example: null
                giftable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Specifies if the plan should be gifted or not.
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |
                    The plan state.
                    \* archived -

                    No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required.
                    \* active -

                    New subscriptions can be created with the plan.
                    \* deleted -

                    Indicates the plan has been deleted.
                  enum:
                  - active
                  - archived
                  example: null
                claim_url:
                  type: string
                  deprecated: false
                  description: |
                    The url to redirect on successful claim. Eg: https://yoursite.com/claim_success.html?plan=basic.
                  maxLength: 500
                  example: null
                tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tiers
                  properties:
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |-
                        <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                        The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                        .</p>
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - field_id
                  - field_value
                  - provider_name
                  example: null
                applicable_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for applicable_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon appplicable to the plan.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon purchased. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which the addon will be charged
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                  example: null
                attached_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for attached_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/v2/pcv-1/subscriptions/create-a-subscription)
                        / [updating](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)
                        the subscription. The value is in decimal. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        The number of billing cycles this addon will be attached to the plan.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies attachment type of the addon to the plan
                          \* recommended -

                          Addon will be charged with this plan unless specifically removed.
                          \* mandatory -

                          Addon will be always charged with this plan.
                        enum:
                        - recommended
                        - mandatory
                        example: null
                      example: null
                  example: null
              required:
              - id
              - name
              example: null
            encoding:
              applicable_addons:
                style: deepObject
                explode: true
              attached_addons:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
  /plans/{plan-id}:
    get:
      summary: Retrieve a plan
      description: |
        This endpoint retrieves a specific plan using the plan ID.
      operationId: retrieve_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: plan-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/plan-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
    post:
      summary: Update a plan
      description: |
        When updating plans that are already linked to an invoice or a subscription, you can only update the following parameters:

        * name
        * invoice_name
        * setup_cost
        * price
        * trial_period
        * trial_period_unit
        * redirect_url
        * enabled_in_hosted_pages
        * meta_data
      operationId: update_a_plan
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: plan-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/plan-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    The display name used in web interface for identifying the plan.
                  maxLength: 100
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description about the plan to show in the hosted pages \& customer portal.
                    **Note:**

                    If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
                  maxLength: 2000
                  example: null
                trial_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The free time window for your customer to try your product. If **zero**
                    is passed, the trial period will be removed.
                  minimum: 0
                  example: null
                trial_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Time unit for the trial period.
                    \* month -

                    In months
                    \* day -

                    In days
                  enum:
                  - day
                  - month
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)
                    .
                    \* cancel_subscription -

                    The subscription cancels.
                    \* activate_subscription -

                    The subscription activates and charges are raised for non-metered items.
                    \* site_default -

                    The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect.
                  enum:
                  - site_default
                  - activate_subscription
                  - cancel_subscription
                  example: null
                period:
                  type: integer
                  format: int32
                  default: 1
                  deprecated: false
                  description: |
                    Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  default: month
                  deprecated: false
                  description: |
                    Defines billing frequency in association with billing period.
                    \* month -

                    Charge based on month(s)
                    \* day -

                    Charge based on day(s)
                    \* week -

                    Charge based on week(s)
                    \* year -

                    Charge based on year(s)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                setup_cost:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    One-time setup fee charged as part of the first invoice.
                  minimum: 1
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The price of the plan when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
                    When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                    , it is the price per unit quantity of the plan. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                    is enabled. .</p>
                  maxLength: 39
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the plan. Applicable if Multicurrency is enabled.
                  maxLength: 3
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically.
                  minimum: 1
                  example: null
                pricing_model:
                  type: string
                  default: flat_fee
                  deprecated: false
                  description: |
                    Defines how the recurring charges for the subscription is calculated.
                    \* tiered -

                    There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                    \* per_unit -

                    A fixed price per unit quantity.
                    \* flat_fee -

                    A fixed price that is not quantity-based.
                    \* volume -

                    The per unit price is based on the tier that the total quantity falls in.
                    \* stairstep -

                    A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  enum:
                  - flat_fee
                  - per_unit
                  - tiered
                  - volume
                  - stairstep
                  example: null
                free_quantity:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.
                  minimum: 0
                  example: null
                free_quantity_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                    is enabled. .
                  maxLength: 33
                  example: null
                addon_applicability:
                  type: string
                  default: all
                  deprecated: false
                  description: |
                    Indicates if all or only some addons are applicable with the plan.
                    \* all -

                    All addons are applicable with this plan.
                    \* restricted -

                    Only addons marked as 'applicable_addons' are applicable with the plan.
                  enum:
                  - all
                  - restricted
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic.
                  maxLength: 500
                  example: null
                enabled_in_hosted_pages:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If true, allow checkout through plan specific hosted page URL for this plan.
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.
                  example: null
                taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
                    have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
                  example: null
                tax_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Tax profile of the plan.
                  maxLength: 50
                  example: null
                tax_code:
                  type: string
                  deprecated: false
                  description: |
                    The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                    .
                  maxLength: 50
                  example: null
                hsn_code:
                  type: string
                  deprecated: false
                  description: |
                    The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                    to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                    * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                    * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .
                  maxLength: 50
                  example: null
                taxjar_product_code:
                  type: string
                  deprecated: false
                  description: |
                    The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                    .
                  maxLength: 50
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* consumed -

                    Transaction is for an item that is consumed directly
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
                  maxLength: 100
                  example: null
                accounting_code:
                  type: string
                  deprecated: false
                  description: |
                    This field is to capture the Account code setup in your Accounting system for integration purposes only.
                  maxLength: 100
                  example: null
                accounting_category1:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category2:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category3:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                    .</li>
                    </ul>
                  maxLength: 100
                  example: null
                accounting_category4:
                  type: string
                  deprecated: false
                  description: |
                    Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

                    * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
                    * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product. .
                  maxLength: 100
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If enabled, charges for this plan/addon will be added to orders.
                  example: null
                shipping_frequency_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
                  minimum: 1
                  example: null
                shipping_frequency_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Defines the shipping frequency in association with shipping period.
                    \* month -

                    Ship based on month(s)
                    \* year -

                    Ship based on year(s)
                    \* day -

                    Ship based on day(s)
                    \* week -

                    Ship based on week(s)
                  enum:
                  - year
                  - month
                  - week
                  - day
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the plan. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                show_description_in_invoices:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Whether the <code><a href="/docs/api/v2/pcv-1/plans/plan-object">plan.description</a></code>
                    should be shown on <a href="/docs/api/invoices/retrieve-invoice-as-pdf">invoice PDFs</a>.
                    If this Boolean is changed, only invoices generated (or <a href="https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">regenerated</a>
                    )after the change are affected; past invoices are not.</p>
                  example: null
                show_description_in_quotes:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)
                    should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
                    If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
                  example: null
                tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tiers
                  properties:
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |-
                        <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                        The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                        .</p>
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - field_id
                  - field_value
                  - provider_name
                  example: null
                applicable_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for applicable_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon appplicable to the plan.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  example: null
                event_based_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for event_based_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon. Multiple addons can be passed.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the addon purchased. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Event on which the addon will be charged
                          \* plan_activation -

                          Addon will be charged on plan activation.
                          \* contract_termination -

                          Addon will be charged on contract termination.
                          \* subscription_activation -

                          Addon will be charged on subscription activation.
                          \* subscription_creation -

                          Addon will be charged on subscription creation.
                          \* subscription_trial_start -

                          Addon will be charged when the trial period starts.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                      items:
                        type: boolean
                        default: true
                        deprecated: false
                        example: null
                      example: null
                  example: null
                attached_addons:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for attached_addons
                  properties:
                    id:
                      type: array
                      description: |
                        Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |-
                        <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                        .</p>
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/v2/pcv-1/subscriptions/create-a-subscription)
                        / [updating](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)
                        the subscription. The value is in decimal. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        The number of billing cycles this addon will be attached to the plan.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies attachment type of the addon to the plan
                          \* recommended -

                          Addon will be charged with this plan unless specifically removed.
                          \* mandatory -

                          Addon will be always charged with this plan.
                        enum:
                        - recommended
                        - mandatory
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              applicable_addons:
                style: deepObject
                explode: true
              attached_addons:
                style: deepObject
                explode: true
              event_based_addons:
                style: deepObject
                explode: true
              tax_providers_fields:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    $ref: "#/components/schemas/Plan"
                    description: <p class="mb-2">Resource object representing plan</p>
                required:
                - plan
                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: []
  /addons/copy:
    post:
      summary: Copy an Addon
      description: "Creates an addon in this site by copying its configurations from\
        \ another site. Copying of archived addons is not supported.  \n**Note:**\n\
        The attribute *tax_profile_id*\nis not copied. In effect, if the plan is taxable,\
        \ it will be mapped to the *Primary*\ntax profile.\n"
      operationId: copy_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                from_site:
                  type: string
                  deprecated: false
                  description: |
                    Your Chargebee site name having the addon to be copied.
                    **Note:**
                    Unless you are copying from a twin site (acme \& acme-test are twin sites), [contact support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)
                    to have this allow-listed.
                  maxLength: 50
                  example: null
                id_at_from_site:
                  type: string
                  deprecated: false
                  description: |
                    Id of the addon to be copied. The new addon created in this site will have the same Id.
                  maxLength: 100
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id of copied addon in this site.
                  maxLength: 100
                  example: null
                for_site_merging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If copy action is performed as part of Chargebee site merge action, pass the value as true.
                  example: null
              required:
              - from_site
              - id_at_from_site
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
  /addons/{addon-id}/unarchive:
    post:
      summary: Unarchive an addon
      description: |
        Unarchives a specific addon using the id.
      operationId: unarchive_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: addon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/addon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
  /addons/{addon-id}:
    get:
      summary: Retrieve an addon
      description: |
        Retrieve a specific addon using the ID.
      operationId: retrieve_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: addon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/addon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
    post:
      summary: Update an addon
      description: |
        When updating addons that already have an invoice or a subscription linked to it, you can only update the following parameters:

        * name
        * invoice_name
        * price
        * included_in_mrr
        * meta_data
      operationId: update_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: addon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/addon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    The display name used in web interface for identifying the addon.
                  maxLength: 100
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description about the addon to show in the hosted pages \& customer portal. This description will not be shown if multiple addons are added.
                    **Note:**

                    If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
                  maxLength: 2000
                  example: null
                charge_type:
                  type: string
                  default: recurring
                  deprecated: false
                  description: |
                    Type of charge.
                    \* non_recurring -

                    Charged immediately and only once every time it is applied.
                    \* recurring -

                    Charges are automatically applied in sync with the billing frequency of subscription.
                  enum:
                  - recurring
                  - non_recurring
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).
                    The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the addon. Applicable if Multicurrency is enabled.
                  maxLength: 3
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon.
                    \* month -

                    Charge based on month(s)
                    \* week -

                    Charge based on week(s)
                    \* not_applicable -

                    not applicable for this addon
                    \* year -

                    Charge based on year(s)
                    \* day -

                    Charge based on Day(S)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  - not_applicable
                  example: null
                pricing_model:
                  type: string
                  deprecated: false
                  description: |
                    Defines how the charges for the addons are calculated.
                    \* tiered -

                    There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                    \* per_unit -

                    A fixed price per unit quantity.
                    \* flat_fee -

                    A fixed price that is not quantity-based.
                    \* volume -

                    The per unit price is based on the tier that the total quantity falls in.
                    \* stairstep -

                    A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  enum:
                  - flat_fee
                  - per_unit
                  - tiered
                  - volume
                  - stairstep
                  example: null
                unit:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.
                    Applicable only for quantity type addons.
                  maxLength: 30
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.
                  example: null
                taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
                    have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
                  example: null
                tax_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Tax profile of the addon.
                  maxLength: 50
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                    \* consumed -

                    Transaction is for an item that is consumed directly
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                tax_code:
                  type: string
                  deprecated: false
                  description: |
                    The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                    .
                  maxLength: 50
                  example: null
                hsn_code:
                  type: string
                  deprecated: false
                  description: |
                    The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                    to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                    * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                    * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                  maxLength: 50
                  example: null
                taxjar_product_code:
                  type: string
                  deprecated: false
                  description: |
                    The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                    .
                  maxLength: 50
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the addon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
                  maxLength: 100
                  example: null
                accounting_code:
                  type: string
                  deprecated: false
                  description: |
                    This field is to capture the Account code setup in your Accounting system for integration purposes only.
                  maxLength: 100
                  example: null
                accounting_category1:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category2:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category3:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                    .</li>
                    </ul>
                  maxLength: 100
                  example: null
                accounting_category4:
                  type: string
                  deprecated: false
                  description: |
                    Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

                    * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
                    * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product. .
                  maxLength: 100
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If enabled, charges for this plan/addon will be added to orders.
                  example: null
                shipping_frequency_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
                  minimum: 1
                  example: null
                shipping_frequency_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Defines the shipping frequency in association with shipping period.
                    \* day -

                    Ship based on day(s)
                    \* week -

                    Ship based on week(s)
                    \* month -

                    Ship based on month(s)
                    \* year -

                    Ship based on year(s)
                  enum:
                  - year
                  - month
                  - week
                  - day
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">The addon is included in MRR calculations for your site. This attribute is only applicable for addons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_type = non_recurring</code>
                    and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    .</p>
                  example: null
                show_description_in_invoices:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
                    should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).
                    If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)
                    ) after the change are affected; past invoices are not.
                  example: null
                show_description_in_quotes:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
                    should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
                    If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The price of the addon when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
                    When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                    , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                    is enabled.</p>
                    <p class="mb-2">This price is for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>  of the addon. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.</p>
                  maxLength: 39
                  example: null
                proration_type:
                  type: string
                  default: site_default
                  deprecated: false
                  description: |-
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    Applicable only for addons with <code><a href="/docs/api/v2/pcv-1/addons/addon-object#pricing_model">pricing_model</a></code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p></div>
                    <p class="mb-2">Specifies how to manage charges or credits for the addon during a <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">subscription update</a>
                    or <a href="/docs/api/v2/pcv-1/estimates/update-subscription-estimate">estimating</a>
                    a subscription update.</p>
                    <span featureId="cb-addon-proration" isMicro="true"></span>
                    * full_term - <p class="mb-2">Charge the full price of the addon item price or give the full credit. Don&#x27;t apply any proration.</p>
                    * site_default - <p class="mb-2">Use the <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration setting</a>
                    .</p>
                    * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p>
                  enum:
                  - site_default
                  - partial_term
                  - full_term
                  example: null
                tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tiers
                  properties:
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |-
                        <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                        The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                        .</p>
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - field_id
                  - field_value
                  - provider_name
                  example: null
              example: null
            encoding:
              tax_providers_fields:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
  /addons:
    get:
      summary: List addons
      description: |
        List the addons. This returns all your current active and archived addons.
      operationId: list_addons
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          A unique ID for your system to identify the addon.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "support_charge"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: support_charge
          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: name
        in: query
        description: |
          optional, string filter

          The display name used in web interface for identifying the addon.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[is\] = "Support Charge"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Support Charge
          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: pricing_model
        in: query
        description: |
          optional, enumerated string filter

          Defines how the charges for the addons are calculated. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *pricing_model\[is\] = "flat_fee"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: flat_fee
          properties:
            is:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              example: null
            is_not:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              example: null
            in:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              pattern: "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
              enum:
              - flat_fee
              - per_unit
              - tiered
              - volume
              - stairstep
              pattern: "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\\
                ]$"
              example: null
      - name: charge_type
        in: query
        description: |
          optional, enumerated string filter

          Type of charge. Possible values are : recurring, non_recurring.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *charge_type\[is_not\] = "recurring"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: recurring
          properties:
            is:
              type: string
              description: |
                \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
              enum:
              - recurring
              - non_recurring
              example: null
            is_not:
              type: string
              description: |
                \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
              enum:
              - recurring
              - non_recurring
              example: null
            in:
              type: string
              description: |
                \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
              enum:
              - recurring
              - non_recurring
              pattern: "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
              enum:
              - recurring
              - non_recurring
              pattern: "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\\
                ]$"
              example: null
      - name: price
        in: query
        description: |
          optional, in cents filter

          Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).
          The unit depends on the [type of currency](/docs/api/getting-started)
          .
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *price\[gte\] = "1300"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1300"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: period
        in: query
        description: |
          optional, integer filter

          Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *period\[is\] = "3"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "3"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: period_unit
        in: query
        description: |
          optional, enumerated string filter

          Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon. Possible values are : day, week, month, year, not_applicable.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *period_unit\[is_not\] = "month"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: month
          properties:
            is:
              type: string
              description: |
                \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
              enum:
              - day
              - week
              - month
              - year
              - not_applicable
              example: null
            is_not:
              type: string
              description: |
                \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
              enum:
              - day
              - week
              - month
              - year
              - not_applicable
              example: null
            in:
              type: string
              description: |
                \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
              enum:
              - day
              - week
              - month
              - year
              - not_applicable
              pattern: "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
              enum:
              - day
              - week
              - month
              - year
              - not_applicable
              pattern: "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\\
                ]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Status of the addon. Possible values are : active, archived, deleted.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is_not\] = "active"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: active
          properties:
            is:
              type: string
              description: |
                \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
              enum:
              - active
              - archived
              - deleted
              example: null
            is_not:
              type: string
              description: |
                \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
              enum:
              - active
              - archived
              - deleted
              example: null
            in:
              type: string
              description: |
                \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[on\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: currency_code
        in: query
        description: |
          optional, string filter

          The currency code (ISO 4217 format) of the addon.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *currency_code\[is\] = "USD"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: USD
          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: channel
        in: query
        description: |
          optional, enumerated string filter

          The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *channel\[is\] = "APP STORE"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: APP STORE
          properties:
            is:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            is_not:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              example: null
            in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "\\* \\`web\\` - The object was created (and is maintained)\
                \ for the web channel directly in Chargebee via API or UI. \\* \\\
                `app_store\\` - The object data is synchronized with data from [in-app\
                \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Apple App Store. Direct manipulation of this object via\
                \ UI or API is disallowed. \\* \\`play_store\\` - The object data\
                \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                \ created in Google Play Store. Direct manipulation of this object\
                \ via UI or API is disallowed.  \nIn-App Subscriptions is currently\
                \ in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                \ for more information.\n"
              enum:
              - web
              - app_store
              - play_store
              pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                ]$"
              example: null
      - name: include_deleted
        in: query
        description: |
          If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted**
          ' attribute will be '**true**
          '.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        addon:
                          $ref: "#/components/schemas/Addon"
                          description: Resource object representing addon
                      required:
                      - addon
                      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: []
    post:
      summary: Create an addon
      description: |
        Create a new addon.
      operationId: create_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique ID for your system to identify the addon.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    The display name used in web interface for identifying the addon.
                  maxLength: 100
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description about the addon to show in the hosted pages \& customer portal. This description will not be shown if multiple addons are added.
                    **Note:**

                    If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
                  maxLength: 2000
                  example: null
                charge_type:
                  type: string
                  default: recurring
                  deprecated: false
                  description: |
                    Type of charge.
                    \* non_recurring -

                    Charged immediately and only once every time it is applied.
                    \* recurring -

                    Charges are automatically applied in sync with the billing frequency of subscription.
                  enum:
                  - recurring
                  - non_recurring
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).
                    The unit depends on the [type of currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the addon.
                  maxLength: 3
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon.
                    \* month -

                    Charge based on month(s)
                    \* week -

                    Charge based on week(s)
                    \* not_applicable -

                    not applicable for this addon
                    \* year -

                    Charge based on year(s)
                    \* day -

                    Charge based on Day(S)
                  enum:
                  - day
                  - week
                  - month
                  - year
                  - not_applicable
                  example: null
                pricing_model:
                  type: string
                  deprecated: false
                  description: |
                    Defines how the charges for the addons are calculated.
                    \* tiered -

                    There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                    \* per_unit -

                    A fixed price per unit quantity.
                    \* flat_fee -

                    A fixed price that is not quantity-based.
                    \* volume -

                    The per unit price is based on the tier that the total quantity falls in.
                    \* stairstep -

                    A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  enum:
                  - flat_fee
                  - per_unit
                  - tiered
                  - volume
                  - stairstep
                  example: null
                unit:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.
                    Applicable only for quantity type addons.
                  maxLength: 30
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.
                  example: null
                taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
                    have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
                  example: null
                tax_profile_id:
                  type: string
                  deprecated: false
                  description: |
                    Tax profile of the addon.
                  maxLength: 50
                  example: null
                avalara_sale_type:
                  type: string
                  deprecated: false
                  description: |
                    Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                    \* retail -

                    Transaction is a sale to an end user
                    \* vendor_use -

                    Transaction is for an item that is subject to vendor use tax
                    \* wholesale -

                    Transaction is a sale to another company that will resell your product or service to another consumer
                    \* consumed -

                    Transaction is for an item that is consumed directly
                  enum:
                  - wholesale
                  - retail
                  - consumed
                  - vendor_use
                  example: null
                avalara_transaction_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                avalara_service_type:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                    integration.
                  example: null
                tax_code:
                  type: string
                  deprecated: false
                  description: |
                    The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
                    .
                  maxLength: 50
                  example: null
                hsn_code:
                  type: string
                  deprecated: false
                  description: |
                    The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
                    to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

                    * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
                    * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
                  maxLength: 50
                  example: null
                taxjar_product_code:
                  type: string
                  deprecated: false
                  description: |
                    The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
                    .
                  maxLength: 50
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the addon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
                  maxLength: 100
                  example: null
                accounting_code:
                  type: string
                  deprecated: false
                  description: |
                    This field is to capture the Account code setup in your Accounting system for integration purposes only.
                  maxLength: 100
                  example: null
                accounting_category1:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category2:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
                    </ul>
                    <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
                  maxLength: 100
                  example: null
                accounting_category3:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
                    <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                    .</li>
                    </ul>
                  maxLength: 100
                  example: null
                accounting_category4:
                  type: string
                  deprecated: false
                  description: |
                    Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

                    * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
                    * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product. .
                  maxLength: 100
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If enabled, charges for this plan/addon will be added to orders.
                  example: null
                shipping_frequency_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
                  minimum: 1
                  example: null
                shipping_frequency_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Defines the shipping frequency in association with shipping period.
                    \* day -

                    Ship based on day(s)
                    \* week -

                    Ship based on week(s)
                    \* month -

                    Ship based on month(s)
                    \* year -

                    Ship based on year(s)
                  enum:
                  - year
                  - month
                  - week
                  - day
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">The addon is included in MRR calculations for your site. This attribute is only applicable for addons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_type = non_recurring</code>
                    and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    .</p>
                  example: null
                show_description_in_invoices:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
                    should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).
                    If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)
                    ) after the change are affected; past invoices are not.
                  example: null
                show_description_in_quotes:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
                    should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
                    If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The price of the addon when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
                    When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
                    , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                    is enabled.</p>
                    <p class="mb-2">This price is for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>  of the addon. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.</p>
                  maxLength: 39
                  example: null
                proration_type:
                  type: string
                  default: site_default
                  deprecated: false
                  description: |-
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    Applicable only for addons with <code><a href="/docs/api/v2/pcv-1/addons/addon-object#pricing_model">pricing_model</a></code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p></div>
                    <p class="mb-2">Specifies how to manage charges or credits for the addon during a <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">subscription update</a>
                    or <a href="/docs/api/v2/pcv-1/estimates/update-subscription-estimate">estimating</a>
                    a subscription update.</p>
                    <span featureId="cb-addon-proration" isMicro="true"></span>
                    * full_term - <p class="mb-2">Charge the full price of the addon item price or give the full credit. Don&#x27;t apply any proration.</p>
                    * site_default - <p class="mb-2">Use the <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration setting</a>
                    .</p>
                    * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p>
                  enum:
                  - site_default
                  - partial_term
                  - full_term
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |
                    Status of the addon.
                    \* archived -

                    No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.
                    \* active -

                    Only active addons can be applied to subscriptions
                    \* deleted -

                    Indicates the addon has been deleted.
                  enum:
                  - active
                  - archived
                  example: null
                tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tiers
                  properties:
                    starting_unit:
                      type: array
                      description: |
                        The lower limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The upper limit of a range of units for the tier
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |-
                        <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                        The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                        .</p>
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Applicable only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies">multi-decimal pricing</a>
                        is enabled.</p>
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                tax_providers_fields:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_providers_fields
                  properties:
                    provider_name:
                      type: array
                      description: |
                        Name of the tax provider currently supported.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_id:
                      type: array
                      description: |
                        Field id of the attribute which tax vendor has provided while getting onboarded with us.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: |
                        The value of the corresponding tax field.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - field_id
                  - field_value
                  - provider_name
                  example: null
              required:
              - charge_type
              - id
              - name
              example: null
            encoding:
              tax_providers_fields:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
  /addons/{addon-id}/delete:
    post:
      summary: Delete an addon
      description: |
        When an addon that already has subscriptions/invoices linked to it is deleted, it does not get completely purged but is instead moved to "Archived" state. No other subscriptions can use this addon but subscriptions already on it will continue to renew. Once an addon has been archived, it cannot be edited or used again and the addon cannot be un-archived.

        If no subscriptions or invoices are linked to an addon, the addon will be permanently deleted from your Chargebee site. This action cannot be undone.

        If an addon that is an applicable item for a coupon is deleted, then the addon will be removed from that coupon's list of applicable items.

        Archiving an addon will not affect coupons in anyway.
      operationId: delete_an_addon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: addon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/addon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  addon:
                    $ref: "#/components/schemas/Addon"
                    description: <p class="mb-2">Resource object representing addon</p>
                required:
                - addon
                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: []
  /coupons:
    get:
      summary: List coupons
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.</p></div>
      operationId: list_coupons
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn>
          <p class="mb-2">Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.</p>
          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the coupon ID contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the coupon ID in the path parameter before making an API call.</p></div>
          <p class="mb-2">.
          <strong class="font-semibold">Supported operators :</strong>
          is, is_not, starts_with, in, not_in</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">id[is] = &quot;OFF2008&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: OFF2008
          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: name
        in: query
        description: |-
          <dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn>
          <p class="mb-2">The display name used in web interface for identifying the coupon.</p>
          <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the name of the coupon set contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the name of the coupon set in the path parameter before making an API call.</p></div>
          <p class="mb-2">.
          <strong class="font-semibold">Supported operators :</strong>
          is, is_not, starts_with, in, not_in</p>
          <p class="mb-2"><strong class="font-semibold">Example →</strong>
          <em class="italic">name[is] = &quot;Offer 10&quot;</em></p>
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: Offer 10
          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: discount_type
        in: query
        description: |
          optional, enumerated string filter

          The type of deduction. Possible values are : fixed_amount, percentage.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *discount_type\[is\] = "fixed_amount"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: fixed_amount
          properties:
            is:
              type: string
              description: |
                \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
              enum:
              - fixed_amount
              - percentage
              - offer_quantity
              example: null
            is_not:
              type: string
              description: |
                \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
              enum:
              - fixed_amount
              - percentage
              - offer_quantity
              example: null
            in:
              type: string
              description: |
                \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
              enum:
              - fixed_amount
              - percentage
              - offer_quantity
              pattern: "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
              enum:
              - fixed_amount
              - percentage
              - offer_quantity
              pattern: "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\\
                ]$"
              example: null
      - name: duration_type
        in: query
        description: |
          optional, enumerated string filter

          Specifies the time duration for which this coupon is attached to the subscription. Possible values are : one_time, forever, limited_period.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *duration_type\[is\] = "forever"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: forever
          properties:
            is:
              type: string
              description: "* `one_time` - The coupon stays attached to the subscription\
                \ till it is applied on an invoice <b>once</b>. It is removed after\
                \ that from the subscription.\n* `forever` - The coupon is attached\
                \ to the subscription and applied on the invoices until explicitly\
                \ removed.\n* `limited_period` - The discount is attached to the subscription\
                \ and applied on the invoices for a limited duration. This duration\
                \ starts from the point it is applied to an invoice for the first\
                \ time and expires after a period specified by <code>period</code>\
                \ and <code>period_unit</code>. "
              enum:
              - one_time
              - forever
              - limited_period
              example: null
            is_not:
              type: string
              description: "* `one_time` - The coupon stays attached to the subscription\
                \ till it is applied on an invoice <b>once</b>. It is removed after\
                \ that from the subscription.\n* `forever` - The coupon is attached\
                \ to the subscription and applied on the invoices until explicitly\
                \ removed.\n* `limited_period` - The discount is attached to the subscription\
                \ and applied on the invoices for a limited duration. This duration\
                \ starts from the point it is applied to an invoice for the first\
                \ time and expires after a period specified by <code>period</code>\
                \ and <code>period_unit</code>. "
              enum:
              - one_time
              - forever
              - limited_period
              example: null
            in:
              type: string
              description: "* `one_time` - The coupon stays attached to the subscription\
                \ till it is applied on an invoice <b>once</b>. It is removed after\
                \ that from the subscription.\n* `forever` - The coupon is attached\
                \ to the subscription and applied on the invoices until explicitly\
                \ removed.\n* `limited_period` - The discount is attached to the subscription\
                \ and applied on the invoices for a limited duration. This duration\
                \ starts from the point it is applied to an invoice for the first\
                \ time and expires after a period specified by <code>period</code>\
                \ and <code>period_unit</code>. "
              enum:
              - one_time
              - forever
              - limited_period
              pattern: "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "* `one_time` - The coupon stays attached to the subscription\
                \ till it is applied on an invoice <b>once</b>. It is removed after\
                \ that from the subscription.\n* `forever` - The coupon is attached\
                \ to the subscription and applied on the invoices until explicitly\
                \ removed.\n* `limited_period` - The discount is attached to the subscription\
                \ and applied on the invoices for a limited duration. This duration\
                \ starts from the point it is applied to an invoice for the first\
                \ time and expires after a period specified by <code>period</code>\
                \ and <code>period_unit</code>. "
              enum:
              - one_time
              - forever
              - limited_period
              pattern: "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\\
                ]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Status of the coupon. Possible values are : active, expired, archived, deleted.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "active"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: active
          properties:
            is:
              type: string
              description: |-
                * `active` - Can be applied to a subscription.
                * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                * `deleted` - Indicates the coupon has been deleted.
              enum:
              - active
              - expired
              - archived
              - deleted
              example: null
            is_not:
              type: string
              description: |-
                * `active` - Can be applied to a subscription.
                * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                * `deleted` - Indicates the coupon has been deleted.
              enum:
              - active
              - expired
              - archived
              - deleted
              example: null
            in:
              type: string
              description: |-
                * `active` - Can be applied to a subscription.
                * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                * `deleted` - Indicates the coupon has been deleted.
              enum:
              - active
              - expired
              - archived
              - deleted
              pattern: "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `active` - Can be applied to a subscription.
                * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                * `deleted` - Indicates the coupon has been deleted.
              enum:
              - active
              - expired
              - archived
              - deleted
              pattern: "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\\
                ]$"
              example: null
      - name: apply_on
        in: query
        description: |
          optional, enumerated string filter

          The amount on the invoice to which the coupon is applied. Possible values are : invoice_amount, each_specified_item.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *apply_on\[is\] = "invoice_amount"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: invoice_amount
          properties:
            is:
              type: string
              description: |-
                * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                * `each_specified_item` - <div prod_cat_ver="2">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                </div>
                <div prod_cat_ver="1">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                </div>
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
              enum:
              - invoice_amount
              - each_specified_item
              example: null
            is_not:
              type: string
              description: |-
                * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                * `each_specified_item` - <div prod_cat_ver="2">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                </div>
                <div prod_cat_ver="1">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                </div>
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
              enum:
              - invoice_amount
              - each_specified_item
              example: null
            in:
              type: string
              description: |-
                * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                * `each_specified_item` - <div prod_cat_ver="2">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                </div>
                <div prod_cat_ver="1">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                </div>
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
              enum:
              - invoice_amount
              - each_specified_item
              pattern: "^\\[(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items)(,(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                * `each_specified_item` - <div prod_cat_ver="2">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                </div>
                <div prod_cat_ver="1">
                    The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                </div>
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
              enum:
              - invoice_amount
              - each_specified_item
              pattern: "^\\[(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items)(,(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items))*\\\
                ]$"
              example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this coupon is created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "145222875"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "145222875"
          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
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1243545465"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1243545465"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              example: null
          example: null
      - name: currency_code
        in: query
        description: |
          optional, string filter

          The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
          ) of the coupon. Applicable for *fixed_amount*
          coupons alone.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *currency_code\[is\] = "USD"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: USD
          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: applicable_item_price_ids
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: day-pass-USD
          properties:
            is:
              type: string
              minLength: 1
              example: null
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        coupon:
                          $ref: "#/components/schemas/Coupon"
                          description: Resource object representing coupon
                      required:
                      - coupon
                      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: []
    post:
      summary: Create a coupon
      description: |
        This API creates a new coupon for a specific promotion or offers.
      operationId: create_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the coupon ID contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the coupon ID in the path parameter before making an API call.</p></div>
                    <p class="mb-2">.</p>
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The display name used in web interface for identifying the coupon.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the name of the coupon set contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the name of the coupon set in the path parameter before making an API call.</p></div>
                    <p class="mb-2">.</p>
                  maxLength: 50
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                discount_type:
                  type: string
                  default: percentage
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the type of discount to be applied.</p>
                    * fixed_amount - <p class="mb-2">A fixed amount is deducted as a discount. The discount amount is specified in <code><a href="/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_amount">discount_amount</a></code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_amount</code>
                    coupons.</p></div>
                    * percentage - <p class="mb-2">A percentage of the original price is deducted as a discount. The discount percentage is specified in <code><a href="/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_percentage">discount_percentage</a></code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#percentage">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">percentage</code>
                    coupons.</p></div>
                    * offer_quantity - <p class="mb-2">A specified number of units of the plan or addon are offered for free. The number of free units is specified in <code><a href="/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_quantity">discount_quantity</a></code>.
                    The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    option is valid only when <code><a href="/docs/api/v2/pcv-1/coupons/create-a-coupon#apply_on">apply_on</a></code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">each_specified_item</code>
                    and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    of the <a href="/docs/api/v2/pcv-1/plans/plan-object#pricing_model">plan</a>
                    or addon is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    coupons.</p></div>
                  enum:
                  - fixed_amount
                  - percentage
                  - offer_quantity
                  example: null
                discount_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The value of the deduction. The format of this value depends on the [kind of currency](/docs/api/currencies)
                    .
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code ([ISO 4217 format](https://www.chargebee.com/docs/2.0/supported-currencies.html)
                    ) of the coupon. Applicable for *fixed_amount*
                    coupons alone.
                  maxLength: 3
                  example: null
                discount_percentage:
                  type: number
                  format: double
                  deprecated: false
                  description: |
                    The percentage of the original amount that should be deducted from it.
                  maximum: 100
                  minimum: 0.01
                  example: null
                discount_quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the number of free units provided for the <a href="/docs/api/v2/pcv-1/plans">plan</a>
                    or <a href="/docs/api/v2/pcv-1/addons">addon</a>
                    , without affecting the total quantity sold. This parameter is applicable only when the <code><a href="/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_type">discount_type</a></code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    .</p>
                  minimum: 1
                  example: null
                apply_on:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount on the invoice to which the coupon is applied.</p>
                    * invoice_amount - <p class="mb-2">The coupon is applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>
                    .</p>
                    * each_unit_of_specified_items - <p class="mb-2">Discount will be applied to each unit of plan and addon items specified.</p>
                    * each_specified_item - <p class="mb-2">The coupon is applied to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.line_item.amount</code>
                    that corresponds to the plan or addon specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_ids</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon_ids</code>
                    .</p>
                    * specified_items_total - <p class="mb-2">Discount will be applied to the total of plan and addon items specified.</p>
                  enum:
                  - invoice_amount
                  - each_specified_item
                  example: null
                duration_type:
                  type: string
                  default: forever
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the time duration for which this coupon is attached to the subscription.</p>
                    * forever - <p class="mb-2">The coupon is attached to the subscription and applied on the invoices until explicitly removed.</p>
                    * limited_period - <p class="mb-2">The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
                    .</p>
                    * one_time - <p class="mb-2">The coupon stays attached to the subscription till it is applied on an invoice <strong class="font-semibold">once</strong>.
                    It is removed after that from the subscription.</p>
                  enum:
                  - one_time
                  - forever
                  - limited_period
                  example: null
                duration_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">(Deprecated)</strong>
                    The duration of time in months for which the coupon is attached to the subscription. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code>.</p>
                    <p class="mb-2"><strong class="font-semibold">Note:</strong>
                    This parameter has been deprecated. Use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
                    instead.</p>
                  maximum: 240
                  minimum: 1
                  example: null
                valid_till:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Date upto which the coupon can be applied to new subscriptions.
                  example: null
                max_redemptions:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "Maximum number of times this coupon can be redeemed.\
                    \  \n**Note:**\n\nIf not specified, the coupon can be redeemed\
                    \ an indefinite number of times.\n\n.\n"
                  minimum: 1
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the coupon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type = one_time</code>
                    and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    .</p>
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The duration of time for which the coupon is attached to the subscription, in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_units</code>.
                    Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
                    is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
                    .</p>
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The unit of time for period. Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
                    is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
                    .</p>
                    * year - <p class="mb-2">A period of 1 calendar year.</p>
                    * month - <p class="mb-2">A period of 1 calendar month.</p>
                    * week - <p class="mb-2">A period of 7 days.</p>
                    * day - <p class="mb-2">A period of 24 hours.</p>
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                plan_constraint:
                  type: string
                  deprecated: false
                  description: |
                    Plans the coupon can be applied to.
                    \* all -

                    Coupon applicable to all plans.
                    \* specific -

                    Coupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).
                    \* none -

                    Coupon not applicable to any plans.
                  enum:
                  - none
                  - all
                  - specific
                  example: null
                addon_constraint:
                  type: string
                  deprecated: false
                  description: |
                    Addons the coupon can be applied to.
                    \* specific -

                    Coupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).
                    \* all -

                    Coupon applicable to all addons.
                    \* none -

                    Coupon not applicable to any addons.
                  enum:
                  - none
                  - all
                  - specific
                  example: null
                plan_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the plan.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                addon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the addon.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |-
                    <p class="mb-2">Status of the coupon.</p>
                    * active - <p class="mb-2">Can be applied to a subscription.</p>
                    * deleted - <p class="mb-2">Indicates the coupon has been deleted.</p>
                    * expired - <p class="mb-2">Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons/coupon-object#max_redemptions">max_redemptions</a></code>
                    or <code><a href="/docs/api/coupons/coupon-object#valid_till">valid_till</a></code>
                    date is past. Existing associations remain unaffected.</p>
                    * archived - <p class="mb-2">Cannot be applied to a subscription. Existing associations remain unaffected.</p>
                  enum:
                  - active
                  - archived
                  example: null
              required:
              - apply_on
              - id
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
  /coupons/{coupon-id}/unarchive:
    post:
      summary: Unarchive a coupon
      description: |
        This API unarchives a specific coupon using the coupon ID.
      operationId: unarchive_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
  /coupons/{coupon-id}/delete:
    post:
      summary: Delete a coupon
      description: |
        If no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone.

        To ensure that existing Subscriptions/Invoices are not affected, Coupons associated with them will not be deleted, but moved to "Archived" state. Once a Coupon has been archived, it cannot be edited or used again unless [unarchived](/docs/api/coupons/unarchive-a-coupon). Unused Coupons codes are deleted.
      operationId: delete_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
  /coupons/copy:
    post:
      summary: Copy a coupon
      description: "Creates a coupon in this site by copying its configurations from\
        \ another site. Copying of archived coupons is not supported.  \n**Note:**\n\
        \n* The plans and addons (refer plan_constraint, plan_ids, addon_constraint,\
        \ addon_ids) that are linked will also be copied. E.g. in the source site,\
        \ the coupon C1 has P1 and P2 as applicable plans. Now, if in the destination\
        \ site only the plan P1 is present, the newly created coupon will have only\
        \ P1 as the applicable plan. So we recommend that you copy the necessary plans\
        \ and addons before copying the coupons.\n* The 'redemptions' count is not\
        \ copied. It will be 0 for the newly created coupon. Hence, if you are copying\
        \ a Expired coupon (expired because max_redemptions is reached), its status\
        \ will be 'Active' when created.\n"
      operationId: copy_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                from_site:
                  type: string
                  deprecated: false
                  description: |
                    Your Chargebee site name having the coupon to be copied.
                    **Note:**
                    Unless you are copying from a twin site (acme \& acme-test are twin sites), [contact support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)
                    to have this allow-listed.
                  maxLength: 50
                  example: null
                id_at_from_site:
                  type: string
                  deprecated: false
                  description: |
                    Id of the coupon to be copied. The new coupon created in this site will have the same Id.
                  maxLength: 100
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id of copied coupon in this site.
                  maxLength: 100
                  example: null
                for_site_merging:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If copy action is performed as part of Chargebee site merge action, pass the value as true.
                    **Note:**
                    If this parameter is passed true coupon state, redmeptions, coupon set and coupon codes associated with this coupon will be copied.
                  example: null
              required:
              - from_site
              - id_at_from_site
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
  /coupons/{coupon-id}:
    get:
      summary: Retrieve a coupon
      description: |-
        <div class="api-description"><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong>
        For sites where both <a href="/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format" class="text-blue-600 hover:text-blue-800 underline">legacy and latest</a> product catalog versions are active, GET API requests return responses in a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code> format by default. This format works with both latest and legacy Product Catalog.</p><p class="mb-2"><strong class="font-semibold">Override options:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: items</code> → Return response in latest product catalog format only.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-response-schema-type: plans_addons</code> → Return response in legacy product catalog format only.</li>
        </ul></div><p class="mb-2">This API retrieves a specific coupon using the coupon ID.</p></div>
      operationId: retrieve_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: coupon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
    post:
      summary: Update a coupon
      description: |
        When updating coupons that are already linked to an invoice or subscription you can only update the following parameters:

        * name
        * invoice name
        * plan_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.
        * addon_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.
        * plan_ids - Applicable when plan_constraint is set as specific. Allows addition of new plan_ids. However, existing plan_ids cannot be removed.
        * addon_ids - Applicable when addon_constraint is set as specific. Allows addition of new addon_ids. However, existing addon_ids cannot be removed.
        * valid_till
        * max_redemptions
        * invoice_notes
        * included_in_mrr
        * meta_data
      operationId: update_a_coupon
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The display name used in web interface for identifying the coupon.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the name of the coupon set contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the name of the coupon set in the path parameter before making an API call.</p></div>
                    <p class="mb-2">.</p>
                  maxLength: 50
                  example: null
                invoice_name:
                  type: string
                  deprecated: false
                  description: |
                    Display name used in invoice. If it is not configured then name is used in invoice.
                  maxLength: 100
                  example: null
                discount_type:
                  type: string
                  default: percentage
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the type of discount to be applied.</p>
                    * fixed_amount - <p class="mb-2">A fixed amount is deducted as a discount. The discount amount is specified in <code><a href="/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_amount">discount_amount</a></code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_amount</code>
                    coupons.</p></div>
                    * percentage - <p class="mb-2">A percentage of the original price is deducted as a discount. The discount percentage is specified in <code><a href="/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_percentage">discount_percentage</a></code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#percentage">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">percentage</code>
                    coupons.</p></div>
                    * offer_quantity - <p class="mb-2">A specified number of units of the plan or addon are offered for free. The number of free units is specified in <code><a href="/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_quantity">discount_quantity</a></code>.
                    The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    option is valid only when <code><a href="/docs/api/v2/pcv-1/coupons/update-a-coupon#apply_on">apply_on</a></code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">each_specified_item</code>
                    and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                    of the <a href="/docs/api/v2/pcv-1/plans/plan-object#pricing_model">plan</a>
                    or addon is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p>
                    <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity">Learn more</a>
                    about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    coupons.</p></div>
                  enum:
                  - fixed_amount
                  - percentage
                  - offer_quantity
                  example: null
                discount_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The value of the deduction. The format of this value depends on the [kind of currency](/docs/api/currencies)
                    .
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code ([ISO 4217 format](https://www.chargebee.com/docs/2.0/supported-currencies.html)
                    ) of the coupon. Applicable for *fixed_amount*
                    coupons alone.
                  maxLength: 3
                  example: null
                discount_percentage:
                  type: number
                  format: double
                  deprecated: false
                  description: |
                    The percentage of the original amount that should be deducted from it.
                  maximum: 100
                  minimum: 0.01
                  example: null
                discount_quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the number of free units provided for the <a href="/docs/api/v2/pcv-1/plans">plan</a>
                    or <a href="/docs/api/v2/pcv-1/addons">addon</a>
                    , without affecting the total quantity sold. This parameter is applicable only when the <code><a href="/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_type">discount_type</a></code>
                    is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
                    .</p>
                  minimum: 1
                  example: null
                apply_on:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The amount on the invoice to which the coupon is applied.</p>
                    * invoice_amount - <p class="mb-2">The coupon is applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>
                    .</p>
                    * each_unit_of_specified_items - <p class="mb-2">Discount will be applied to each unit of plan and addon items specified.</p>
                    * each_specified_item - <p class="mb-2">The coupon is applied to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.line_item.amount</code>
                    that corresponds to the plan or addon specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_ids</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon_ids</code>
                    .</p>
                    * specified_items_total - <p class="mb-2">Discount will be applied to the total of plan and addon items specified.</p>
                  enum:
                  - invoice_amount
                  - each_specified_item
                  example: null
                duration_type:
                  type: string
                  default: forever
                  deprecated: false
                  description: |-
                    <p class="mb-2">Specifies the time duration for which this coupon is attached to the subscription.</p>
                    * forever - <p class="mb-2">The coupon is attached to the subscription and applied on the invoices until explicitly removed.</p>
                    * limited_period - <p class="mb-2">The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
                    .</p>
                    * one_time - <p class="mb-2">The coupon stays attached to the subscription till it is applied on an invoice <strong class="font-semibold">once</strong>.
                    It is removed after that from the subscription.</p>
                  enum:
                  - one_time
                  - forever
                  - limited_period
                  example: null
                duration_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">(Deprecated)</strong>
                    The duration of time in months for which the coupon is attached to the subscription. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code>.</p>
                    <p class="mb-2"><strong class="font-semibold">Note:</strong>
                    This parameter has been deprecated. Use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
                    and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
                    instead.</p>
                  maximum: 240
                  minimum: 1
                  example: null
                valid_till:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Date upto which the coupon can be applied to new subscriptions.
                  example: null
                max_redemptions:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "Maximum number of times this coupon can be redeemed.\
                    \  \n**Note:**\n\nIf not specified, the coupon can be redeemed\
                    \ an indefinite number of times.\n\n.\n"
                  minimum: 1
                  example: null
                invoice_notes:
                  type: string
                  deprecated: false
                  description: |
                    A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
                    displayed on the invoice PDF.
                  maxLength: 2000
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the coupon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |-
                    <p class="mb-2">The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type = one_time</code>
                    and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    .</p>
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The duration of time for which the coupon is attached to the subscription, in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_units</code>.
                    Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
                    is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
                    .</p>
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The unit of time for period. Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
                    is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
                    .</p>
                    * year - <p class="mb-2">A period of 1 calendar year.</p>
                    * month - <p class="mb-2">A period of 1 calendar month.</p>
                    * week - <p class="mb-2">A period of 7 days.</p>
                    * day - <p class="mb-2">A period of 24 hours.</p>
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                plan_constraint:
                  type: string
                  deprecated: false
                  description: |
                    Plans the coupon can be applied to.
                    \* all -

                    Coupon applicable to all plans.
                    \* specific -

                    Coupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).
                    \* none -

                    Coupon not applicable to any plans.
                  enum:
                  - none
                  - all
                  - specific
                  example: null
                addon_constraint:
                  type: string
                  deprecated: false
                  description: |
                    Addons the coupon can be applied to.
                    \* specific -

                    Coupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).
                    \* all -

                    Coupon applicable to all addons.
                    \* none -

                    Coupon not applicable to any addons.
                  enum:
                  - none
                  - all
                  - specific
                  example: null
                plan_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the plan.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                addon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Identifier of the addon.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: <p class="mb-2">Resource object representing coupon</p>
                required:
                - coupon
                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: []
  /coupon_sets:
    get:
      summary: List coupon sets
      description: |
        Use this API to get the list of all the coupon sets.
      operationId: list_coupon_sets
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Uniquely identifies a coupon_set.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "bulk-codes-1"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: bulk-codes-1
          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: name
        in: query
        description: |
          optional, string filter

          Name of the coupon set.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[is\] = "bulk-codes-1"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: bulk-codes-1
          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: coupon_id
        in: query
        description: |
          optional, string filter

          Coupon id linked to coupon set.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *coupon_id\[is_not\] = "OFF2008"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: OFF2008
          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: total_count
        in: query
        description: |
          optional, integer filter

          No of coupon codes present in coupon set.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *total_count\[is_not\] = "10"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "10"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: redeemed_count
        in: query
        description: |
          optional, integer filter

          No of redeemed codes.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *redeemed_count\[gt\] = "5"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "5"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      - name: archived_count
        in: query
        description: |
          optional, integer filter

          No of archived codes.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *archived_count\[lte\] = "2"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "2"
          properties:
            is:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            is_not:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            lte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gt:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            gte:
              type: string
              format: number
              pattern: ^-?\d+$
              example: null
            between:
              type: string
              pattern: "^\\[-?\\d+,-?\\d+\\]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        coupon_set:
                          $ref: "#/components/schemas/CouponSet"
                          description: Resource object representing coupon_set
                      required:
                      - coupon_set
                      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: []
    post:
      summary: Create a coupon set
      description: |
        Create a coupon set with a coupon code compatible to your product offers and promotional discounts
      operationId: create_a_coupon_set
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                coupon_id:
                  type: string
                  deprecated: false
                  description: |
                    Coupon id linked to coupon set.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    Name of the coupon set.
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    Uniquely identifies a coupon_set.
                  maxLength: 50
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the coupon set. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
              required:
              - coupon_id
              - id
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_sets/{coupon-set-id}/update:
    post:
      summary: Update a coupon set
      description: <div class="api-description"><p class="mb-2">Use this API to update
        a specific coupon set by updating its <code class="bg-gray-100 text-gray-800
        font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono
        whitespace-nowrap">name</code> and the <code class="bg-gray-100 text-gray-800
        font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono
        whitespace-nowrap">meta_data</code>.</p></div>
      operationId: update_a_coupon_set
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-set-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-set-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    Name of the coupon set.
                  maxLength: 50
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the coupon set. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_sets/{coupon-set-id}:
    get:
      summary: Retrieve a coupon set
      description: |
        Use this API to retrieve a specific coupon set.
      operationId: retrieve_a_coupon_set
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: coupon-set-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-set-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_sets/{coupon-set-id}/add_coupon_codes:
    post:
      summary: Add coupon codes to coupon set
      description: |
        This API add coupon codes to an existing coupon set.
      operationId: add_coupon_codes_to_coupon_set
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-set-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-set-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                code:
                  type: array
                  deprecated: false
                  description: |
                    You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_sets/{coupon-set-id}/delete_unused_coupon_codes:
    post:
      summary: Delete unused coupon codes
      description: |
        Use this API to delete all the unutilised coupon codes from a specific coupon set.
      operationId: delete_unused_coupon_codes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-set-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-set-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_sets/{coupon-set-id}/delete:
    post:
      summary: Delete a coupon set
      description: |
        Use this endpoint to delete a specific coupon set
      operationId: delete_a_coupon_set
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-set-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-set-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: <p class="mb-2">Resource object representing coupon_set</p>
                required:
                - coupon_set
                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: []
  /coupon_codes:
    get:
      summary: List coupon codes
      description: |
        List the available coupon codes.
      operationId: list_coupon_codes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: code
        in: query
        description: |
          optional, string filter

          Unique coupon code that can be redeemed only once.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *code\[is\] = "OFF2009"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: OFF2009
          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: coupon_id
        in: query
        description: |
          optional, string filter

          Id of the main coupon resource.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *coupon_id\[is\] = "OFF20"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: OFF20
          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: coupon_set_name
        in: query
        description: |
          optional, string filter

          Coupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *coupon_set_name\[is_not\] = "OFF20"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: OFF20
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Status of the coupon code. Possible values are : not_redeemed, redeemed, archived.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "redeemed"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: redeemed
          properties:
            is:
              type: string
              description: |
                \* \`not_redeemed\` - Can be applied to a subscription. \* \`redeemed\` - Cannot be applied to a subscription as the coupon code has been already used. \* \`archived\` - Cannot be applied to a subscription as it has been made inactive.
              enum:
              - not_redeemed
              - redeemed
              - archived
              example: null
            is_not:
              type: string
              description: |
                \* \`not_redeemed\` - Can be applied to a subscription. \* \`redeemed\` - Cannot be applied to a subscription as the coupon code has been already used. \* \`archived\` - Cannot be applied to a subscription as it has been made inactive.
              enum:
              - not_redeemed
              - redeemed
              - archived
              example: null
            in:
              type: string
              description: |
                \* \`not_redeemed\` - Can be applied to a subscription. \* \`redeemed\` - Cannot be applied to a subscription as the coupon code has been already used. \* \`archived\` - Cannot be applied to a subscription as it has been made inactive.
              enum:
              - not_redeemed
              - redeemed
              - archived
              pattern: "^\\[(not_redeemed|redeemed|archived)(,(not_redeemed|redeemed|archived))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`not_redeemed\` - Can be applied to a subscription. \* \`redeemed\` - Cannot be applied to a subscription as the coupon code has been already used. \* \`archived\` - Cannot be applied to a subscription as it has been made inactive.
              enum:
              - not_redeemed
              - redeemed
              - archived
              pattern: "^\\[(not_redeemed|redeemed|archived)(,(not_redeemed|redeemed|archived))*\\\
                ]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        coupon_code:
                          $ref: "#/components/schemas/CouponCode"
                          description: Resource object representing coupon_code
                      required:
                      - coupon_code
                      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: []
  /coupon_codes/{coupon-code-code}:
    get:
      summary: Retrieve a coupon code
      description: |
        Retrieves a specific coupon code details.
      operationId: retrieve_a_coupon_code
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: coupon-code-code
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-code-code"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_code:
                    $ref: "#/components/schemas/CouponCode"
                    description: <p class="mb-2">Resource object representing coupon_code</p>
                required:
                - coupon_code
                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: []
  /coupon_codes/{coupon-code-code}/archive:
    post:
      summary: Archive a coupon code
      description: |
        Archives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.
      operationId: archive_a_coupon_code
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: coupon-code-code
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/coupon-code-code"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_code:
                    $ref: "#/components/schemas/CouponCode"
                    description: <p class="mb-2">Resource object representing coupon_code</p>
                required:
                - coupon_code
                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: []
  /addresses:
    get:
      summary: Retrieve an address
      description: |
        Retrieves an address resource for a subscription and the specified label.
      operationId: retrieve_an_address
      parameters:
      - name: subscription_id
        in: query
        description: |
          A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: label
        in: query
        description: |
          Label to identify the address. This is unique for all the address for a subscription.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  address:
                    $ref: "#/components/schemas/Address"
                    description: <p class="mb-2">Resource object representing address</p>
                required:
                - address
                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: []
    post:
      summary: Update an address
      description: |
        Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
      operationId: update_an_address
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                  maxLength: 50
                  example: null
                label:
                  type: string
                  deprecated: false
                  description: |
                    Label to identify the address. This is unique for all the address for a subscription.
                  maxLength: 50
                  example: null
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    First name.
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    Last name.
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    Email.
                  maxLength: 70
                  example: null
                company:
                  type: string
                  deprecated: false
                  description: |
                    Company name.
                  maxLength: 250
                  example: null
                phone:
                  type: string
                  deprecated: false
                  description: |
                    Phone number.
                  maxLength: 50
                  example: null
                addr:
                  type: string
                  deprecated: false
                  description: |
                    Address line 1.
                  maxLength: 150
                  example: null
                extended_addr:
                  type: string
                  deprecated: false
                  description: |
                    Address line 2.
                  maxLength: 150
                  example: null
                extended_addr2:
                  type: string
                  deprecated: false
                  description: |
                    Address line 3.
                  maxLength: 150
                  example: null
                city:
                  type: string
                  deprecated: false
                  description: |
                    Name of the city.
                  maxLength: 50
                  example: null
                state_code:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a>
                    without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                    ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                    ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                    ).</p>
                  maxLength: 50
                  example: null
                state:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                    is provided.</p>
                  maxLength: 50
                  example: null
                zip:
                  type: string
                  deprecated: false
                  description: |
                    Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                    .
                  maxLength: 20
                  example: null
                country:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                    .</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong>:
                    If you enter an invalid country code, the system will return an error.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                    <p class="mb-2">.</p>
                  maxLength: 50
                  example: null
                validation_status:
                  type: string
                  default: not_validated
                  deprecated: false
                  description: |
                    The address verification status.
                    \* partially_valid -

                    The address is valid for taxability but has not been validated for shipping.
                    \* not_validated -

                    Address is not yet validated.
                    \* invalid -

                    Address is invalid.
                    \* valid -

                    Address was validated successfully.
                  enum:
                  - not_validated
                  - valid
                  - partially_valid
                  - invalid
                  example: null
              required:
              - label
              - subscription_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  address:
                    $ref: "#/components/schemas/Address"
                    description: <p class="mb-2">Resource object representing address</p>
                required:
                - address
                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: []
  /events:
    get:
      summary: List events
      description: |
        Retrieves list of events.
      operationId: list_events
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Uniquely identifies a event.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is_not\] = "8ndk0hbKm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8ndk0hbKm
          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: webhook_status
        in: query
        description: |
          optional, enumerated string filter

          Returns the events (occurred in the past 6 days) which has this status in any of the events' webhooks.
          **Note**:
          To retrieve events which have occurred before the 6 day period, use the occurred_at(start_time/end_time) attribute. Possible values are : not_configured, scheduled, succeeded, re_scheduled, failed, skipped, not_applicable.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *webhook_status\[is\] = "succeeded"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: succeeded
          properties:
            is:
              type: string
              description: |
                \* \`not_configured\` - Webhook was not configured when this event occurred \* \`scheduled\` - Webhook call has been scheduled. \* \`succeeded\` - Webhook call was successful. \* \`re_scheduled\` - Webhook call has been rescheduled due failure(s) in previous call(s) \* \`failed\` - Webhook call has been suspended after the all retries have resulted in failure. \* \`skipped\` - Skipped as specified in request \* \`not_applicable\` - Webhook call is not applicable for this event. \* \`disabled\` - Disabled as no longer used \* \`rate_limited\` - Webhook call was rate limited.
              enum:
              - not_configured
              - scheduled
              - succeeded
              - re_scheduled
              - failed
              - skipped
              - not_applicable
              - disabled
              - rate_limited
              example: null
            is_not:
              type: string
              description: |
                \* \`not_configured\` - Webhook was not configured when this event occurred \* \`scheduled\` - Webhook call has been scheduled. \* \`succeeded\` - Webhook call was successful. \* \`re_scheduled\` - Webhook call has been rescheduled due failure(s) in previous call(s) \* \`failed\` - Webhook call has been suspended after the all retries have resulted in failure. \* \`skipped\` - Skipped as specified in request \* \`not_applicable\` - Webhook call is not applicable for this event. \* \`disabled\` - Disabled as no longer used \* \`rate_limited\` - Webhook call was rate limited.
              enum:
              - not_configured
              - scheduled
              - succeeded
              - re_scheduled
              - failed
              - skipped
              - not_applicable
              - disabled
              - rate_limited
              example: null
            in:
              type: string
              description: |
                \* \`not_configured\` - Webhook was not configured when this event occurred \* \`scheduled\` - Webhook call has been scheduled. \* \`succeeded\` - Webhook call was successful. \* \`re_scheduled\` - Webhook call has been rescheduled due failure(s) in previous call(s) \* \`failed\` - Webhook call has been suspended after the all retries have resulted in failure. \* \`skipped\` - Skipped as specified in request \* \`not_applicable\` - Webhook call is not applicable for this event. \* \`disabled\` - Disabled as no longer used \* \`rate_limited\` - Webhook call was rate limited.
              enum:
              - not_configured
              - scheduled
              - succeeded
              - re_scheduled
              - failed
              - skipped
              - not_applicable
              - disabled
              - rate_limited
              pattern: "^\\[(not_configured|scheduled|succeeded|re_scheduled|failed|skipped|not_applicable|disabled|rate_limited)(,(not_configured|scheduled|succeeded|re_scheduled|failed|skipped|not_applicable|disabled|rate_limited))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`not_configured\` - Webhook was not configured when this event occurred \* \`scheduled\` - Webhook call has been scheduled. \* \`succeeded\` - Webhook call was successful. \* \`re_scheduled\` - Webhook call has been rescheduled due failure(s) in previous call(s) \* \`failed\` - Webhook call has been suspended after the all retries have resulted in failure. \* \`skipped\` - Skipped as specified in request \* \`not_applicable\` - Webhook call is not applicable for this event. \* \`disabled\` - Disabled as no longer used \* \`rate_limited\` - Webhook call was rate limited.
              enum:
              - not_configured
              - scheduled
              - succeeded
              - re_scheduled
              - failed
              - skipped
              - not_applicable
              - disabled
              - rate_limited
              pattern: "^\\[(not_configured|scheduled|succeeded|re_scheduled|failed|skipped|not_applicable|disabled|rate_limited)(,(not_configured|scheduled|succeeded|re_scheduled|failed|skipped|not_applicable|disabled|rate_limited))*\\\
                ]$"
              example: null
      - name: event_type
        in: query
        description: |
          optional, enumerated string filter

          Specify it if you need to fetch events of a particular type. Possible values are : plan_created, plan_updated, plan_deleted, addon_created, addon_updated, addon_deleted, coupon_created, coupon_updated, coupon_deleted, coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_deleted, coupon_codes_updated, customer_created, customer_changed, customer_deleted, customer_moved_out, customer_moved_in, promotional_credits_added, promotional_credits_deducted, subscription_created, subscription_created_with_backdating, subscription_started, subscription_trial_end_reminder, subscription_activated, subscription_activated_with_backdating, subscription_changed, mrr_updated, subscription_changed_with_backdating, subscription_cancellation_scheduled, subscription_cancellation_reminder, subscription_cancelled, subscription_canceled_with_backdating, subscription_reactivated, subscription_reactivated_with_backdating, subscription_renewed, subscription_scheduled_cancellation_removed, subscription_changes_scheduled, subscription_scheduled_changes_removed, subscription_shipping_address_updated, subscription_deleted, subscription_paused, subscription_pause_scheduled, subscription_scheduled_pause_removed, subscription_resumed, subscription_resumption_scheduled, subscription_scheduled_resumption_removed, subscription_advance_invoice_schedule_added, subscription_advance_invoice_schedule_updated, subscription_advance_invoice_schedule_removed, pending_invoice_created, pending_invoice_updated, invoice_generated, invoice_generated_with_backdating, invoice_updated, invoice_deleted, credit_note_created, credit_note_created_with_backdating, credit_note_updated, credit_note_deleted, subscription_renewal_reminder, transaction_created, transaction_updated, transaction_deleted, payment_succeeded, payment_failed, payment_refunded, payment_initiated, refund_initiated, authorization_succeeded, authorization_voided, card_added, card_updated, card_expiry_reminder, card_expired, card_deleted, payment_source_added, payment_source_updated, payment_source_deleted, payment_source_expiring, payment_source_expired, virtual_bank_account_added, virtual_bank_account_updated, virtual_bank_account_deleted, token_created, token_consumed, token_expired, unbilled_charges_created, unbilled_charges_voided, unbilled_charges_deleted, unbilled_charges_invoiced, order_created, order_updated, order_cancelled, order_delivered, order_returned, order_ready_to_process, order_ready_to_ship, order_deleted, order_resent, quote_created, quote_updated, quote_deleted, tax_withheld_recorded, tax_withheld_deleted, tax_withheld_refunded, gift_scheduled, gift_unclaimed, gift_claimed, gift_expired, gift_cancelled, gift_updated, hierarchy_created, hierarchy_deleted, payment_intent_created, payment_intent_updated, contract_term_created, contract_term_renewed, contract_term_terminated, contract_term_completed, contract_term_cancelled.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *event_type\[is\] = "customer_created"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: customer_created
          properties:
            is:
              type: string
              description: |
                \* \`plan_created\` - Sent when a plan is created. \* \`plan_updated\` - Sent when a plan is changed. \* \`plan_deleted\` - Sent when a plan is deleted. \* \`addon_created\` - Sent when a addon is created. \* \`addon_updated\` - Sent when a addon is changed. \* \`addon_deleted\` - Sent when a addon is deleted. \* \`coupon_created\` - Sent when a coupon is created. \* \`coupon_updated\` - Sent when a coupon is changed. \* \`coupon_deleted\` - Sent when a coupon is deleted. \* \`coupon_set_created\` - Sent when a coupon set is created \* \`coupon_set_updated\` - Sent when a coupon set is changed \* \`coupon_set_deleted\` - Sent when a coupon set is deleted \* \`coupon_codes_added\` - Sent when coupon codes are added in coupon set \* \`coupon_codes_deleted\` - Sent when coupon codes are deleted in coupon set \* \`coupon_codes_updated\` - Sent when coupon codes are updated \* \`customer_created\` - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation. \* \`customer_changed\` - Sent when a customer is changed \* \`customer_deleted\` - Sent when a customer is deleted \* \`customer_moved_out\` - Sent when a customer is copied to another site \* \`customer_moved_in\` - Sent when a customer is copied from another site \* \`promotional_credits_added\` - Sent when a customer prmotion credits added \* \`promotional_credits_deducted\` - Sent when a customer prmotion credits deducted \* \`subscription_created\` - Sent when a new subscription is created. \* \`subscription_created_with_backdating\` - Sent when a new subscription is created with backdating. \* \`subscription_started\` - Sent when a 'future' subscription gets started at the scheduled date. \* \`subscription_trial_end_reminder\` - Sent when the customer's trial period is about to end. \* \`subscription_activated\` - Sent after the subscription has been moved from trial to active state \* \`subscription_activated_with_backdating\` - Sent after the subscription changes to \`active\` from another \`status\`, while the change is backdated. \* \`subscription_changed\` - Sent after the subscription's recurring items have been changed \* \`subscription_trial_extended\` - Trial Extension \* \`mrr_updated\` - Sent when either of MRR or CMRR of a subscription changes \* \`subscription_changed_with_backdating\` - Sent after the subscription's recurring items have been changed with backdated date \* \`subscription_cancellation_scheduled\` - Sent when subscription is scheduled to cancel at end of current term \* \`subscription_cancellation_reminder\` - Sent when the customer's subscription is nearing it's scheduled cancellation date. \* \`subscription_cancelled\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_canceled_with_backdating\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_reactivated\` - Sent when the subscription is moved from cancelled state to active or in_trial state \* \`subscription_reactivated_with_backdating\` - Sent when the subscription is moved from cancelled state to active or in_trial state with past date \* \`subscription_renewed\` - Sent when the subscription is renewed from the current term. \* \`subscription_items_renewed\` - Sent when one or more Subscription Items are renewed \* \`subscription_scheduled_cancellation_removed\` - Sent when scheduled cancellation is removed for the subscription. \* \`subscription_changes_scheduled\` - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term. \* \`subscription_scheduled_changes_removed\` - Sent when scheduled change for the subscription is removed. \* \`subscription_shipping_address_updated\` - Triggered when shipping address is added or updated for a subscription. \* \`subscription_deleted\` - Sent when a subscription has been deleted \* \`subscription_paused\` - Sent when the subscription is paused. \* \`subscription_pause_scheduled\` - Sent when the subscription is scheduled to pause. \* \`subscription_scheduled_pause_removed\` - Triggered when scheduled pause is removed for the subscription. \* \`subscription_resumed\` - Sent when the subscription is moved from paused state to active state \* \`subscription_resumption_scheduled\` - Triggered when the subscription resumption is scheduled. \* \`subscription_scheduled_resumption_removed\` - Triggered when scheduled resumption is removed for the subscription. \* \`subscription_advance_invoice_schedule_added\` - Triggered when advance invoice is scheduled for a subscription. \* \`subscription_advance_invoice_schedule_updated\` - Triggered when scheduled advance invoice is updated for a subscription. \* \`subscription_advance_invoice_schedule_removed\` - Triggered when scheduled advance invoice is removed for a subscription. \* \`pending_invoice_created\` - Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled. \* \`pending_invoice_updated\` - Event triggered when the option "Notify and wait to close invoices" is enabled, and the 'Pending' invoice is updated. \* \`invoice_generated\` - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed. \* \`invoice_generated_with_backdating\` - Event triggered when a new invoice is generated with past date as invoice date. \* \`invoice_updated\` - Triggered when the invoice's shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed. \* \`invoice_deleted\` - Event triggered when an invoice is deleted. \* \`credit_note_created\` - Sent when a credit note is created \* \`credit_note_created_with_backdating\` - Sent when a credit note is created with past date as credit note date \* \`credit_note_updated\` - Sent when a credit note is updated \* \`credit_note_deleted\` - Sent when a credit note is deleted \* \`subscription_renewal_reminder\` - Sent before each subscription's renewal based on plan's period \* \`transaction_created\` - Triggered when a transaction is recorded \* \`transaction_updated\` - Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated. \* \`transaction_deleted\` - Triggered when a transaction is deleted. \* \`payment_succeeded\` - Sent when the payment is successfully collected \* \`payment_failed\` - Sent when attempt to charge customer's credit card fails \* \`dunning_updated\` - Sent when dunning is paused for an invoice \* \`payment_refunded\` - Sent when a payment refund is made \* \`payment_initiated\` - Sent when a payment is initiated via direct debit \* \`refund_initiated\` - Sent when a refund is initiated via direct debit \* \`netd_payment_due_reminder\` - \*\*(Deprecated)\*\* Sent when a invoice's due period is about to end \* \`authorization_succeeded\` - Triggered when a authorization transaction is created. \* \`authorization_voided\` - Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time. \* \`card_added\` - Sent when a card is added for a customer. \* \`card_updated\` - Sent when the card is updated for a customer. \* \`card_expiry_reminder\` - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date. \* \`card_expired\` - Sent when a card for a customer is expired \* \`card_deleted\` - Sent when a card is deleted for a customer \* \`payment_source_added\` - Sent when a payment source is added for a customer. \* \`payment_source_updated\` - Sent when the payment source is updated for a customer or when role is assigned to the payment source. \* \`payment_source_deleted\` - Sent when a payment source is deleted for a customer \* \`payment_source_expiring\` - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date. \* \`payment_source_expired\` - Sent when a payment source for a customer is expired \* \`payment_source_locally_deleted\` - Sent when a payment source for a customer removed from Chargebee \* \`virtual_bank_account_added\` - Sent when a virtual bank account is added for a customer. \* \`virtual_bank_account_updated\` - Sent when the virtual bank account is updated for a customer. \* \`virtual_bank_account_deleted\` - Sent when a virtual bank account is deleted for a customer. \* \`token_created\` - Sent when a Token is created \* \`token_consumed\` - Sent when a Token is consumed \* \`token_expired\` - Sent when a Token is expired \* \`unbilled_charges_created\` - Triggered when unbilled charges are created \* \`unbilled_charges_voided\` - Triggered when unbilled charges are voided \* \`unbilled_charges_deleted\` - Triggered when unbilled charges are deleted \* \`unbilled_charges_invoiced\` - Triggered when unbilled charges are invoiced \* \`order_created\` - Triggered when order is created \* \`order_updated\` - Triggered when order is updated \* \`order_cancelled\` - Triggered when order is cancelled \* \`order_delivered\` - Triggered when order is marked as delivered \* \`order_returned\` - Triggered when order is marked as returned \* \`order_ready_to_process\` - Triggered when order reaches it's order date \* \`order_ready_to_ship\` - Triggered when order reaches it's shipping date \* \`order_deleted\` - Triggered when order is deleted \* \`order_resent\` - Triggered when order is resent \* \`quote_created\` - Triggered when quote is created \* \`quote_updated\` - Triggered when quote is updated \* \`quote_deleted\` - Triggered when quote is deleted \* \`tax_withheld_recorded\` - Triggered when a tax withheld is recorded for an invoice \* \`tax_withheld_deleted\` - Triggered when a tax withheld is deleted \* \`tax_withheld_refunded\` - Sent when a tax withheld refund is made \* \`gift_scheduled\` - Triggered when a new gift is created \* \`gift_unclaimed\` - Triggered when a new gift is unclaimed and is ready to be claimed \* \`gift_claimed\` - Triggered when a gift is claimed \* \`gift_expired\` - Triggered when a gift expires \* \`gift_cancelled\` - Triggered when a gift is cancelled. \* \`gift_updated\` - Triggered when a gift is updated \* \`hierarchy_created\` - Triggered when a hierarchy is created \* \`hierarchy_deleted\` - Triggered when a hierarchy is deleted \* \`payment_intent_created\` - Sent when a Payment intent is created \* \`payment_intent_updated\` - Sent when a Payment intent is updated \* \`contract_term_created\` - Triggered when new contract term is created \* \`contract_term_renewed\` - Triggered when new contract term is renewed \* \`contract_term_terminated\` - Triggered when contract term is terminated \* \`contract_term_completed\` - Triggered when contract term is completed \* \`contract_term_cancelled\` - Triggered when contract term is cancelled \* \`voucher_created\` - Triggered when a payment voucher is created \* \`voucher_expired\` - Triggered when a payment voucher is expired \* \`voucher_create_failed\` - Triggered when a payment voucher creation is failed \* \`subscription_ramp_created\` - Triggered when a subscription ramp is created. \* \`subscription_ramp_deleted\` - Triggered when a subscription ramp is deleted. \* \`subscription_ramp_applied\` - Triggered when a subscription ramp is applied. \* \`subscription_ramp_drafted\` - Triggered when a subscription ramp is moved to draft status. \* \`subscription_ramp_updated\` - Triggered when a subscription ramp is updated. \* \`subscription_moved_in\` - Triggered when a subscription moved from other customer \* \`subscription_moved_out\` - Triggered when a subscription moved to other customer \* \`subscription_movement_failed\` - Triggered when a subscription movement failed \* \`omnichannel_subscription_created\` - Triggered when an omnichannel subscription is created \* \`omnichannel_subscription_item_renewed\` - Triggered when an omnichannel subscription item is renewed \* \`omnichannel_subscription_item_downgrade_scheduled\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item is downgrade is scheduled \* \`omnichannel_subscription_item_scheduled_downgrade_removed\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item scheduled downgrade is removed \* \`omnichannel_subscription_item_downgraded\` - Triggered when an omnichannel subscription item is downgraded \* \`omnichannel_subscription_item_expired\` - Triggered when an omnichannel subscription item is expired \* \`omnichannel_subscription_item_cancellation_scheduled\` - Triggered when an omnichannel subscription item is scheduled for cancellation \* \`omnichannel_subscription_item_scheduled_cancellation_removed\` - Triggered when an omnichannel subscription item scheduled cancellation is removed \* \`omnichannel_subscription_item_resubscribed\` - Triggered when an omnichannel subscription item is resubscribed \* \`omnichannel_subscription_item_upgraded\` - Triggered when an omnichannel subscription item is upgraded \* \`omnichannel_subscription_item_cancelled\` - Triggered when an omnichannel subscription item is cancelled \* \`omnichannel_subscription_imported\` - Triggered when an omnichannel subscription item is imported \* \`omnichannel_subscription_item_grace_period_started\` - Triggered when an omnichannel subscription item's grace period has started \* \`omnichannel_subscription_item_grace_period_expired\` - Triggered when an omnichannel subscription item's grace period has expired \* \`omnichannel_subscription_item_dunning_started\` - Triggered when an omnichannel subscription item's dunning has started \* \`omnichannel_subscription_item_dunning_expired\` - Triggered when an omnichannel subscription item's dunning has expired \* \`rule_created\` - Triggered when a rule is created \* \`rule_updated\` - Triggered when a rule is updated \* \`rule_deleted\` - Triggered when a rule is deleted \* \`record_purchase_failed\` - Triggered when an omnichannel record purchase is failed \* \`omnichannel_subscription_item_change_scheduled\` - Triggered when an omnichannel subscription item change is scheduled \* \`omnichannel_subscription_item_scheduled_change_removed\` - Triggered when an omnichannel subscription item scheduled change is removed \* \`omnichannel_subscription_item_reactivated\` - Triggered when an omnichannel subscription item's refund is reversed \* \`sales_order_created\` - Triggered when sales order is created \* \`sales_order_updated\` - Triggered when sales order is updated \* \`omnichannel_subscription_item_changed\` - Triggered when an omnichannel subscription item is changed \* \`omnichannel_subscription_item_paused\` - Triggered when an omnichannel subscription item is paused \* \`omnichannel_subscription_item_resumed\` - Triggered when an omnichannel subscription item is resumed \* \`omnichannel_one_time_order_created\` - Triggered when an omnichannel one time order is created \* \`omnichannel_one_time_order_item_cancelled\` - Triggered when an omnichannel one time order item is cancelled \* \`usage_file_ingested\` - Triggered when a usage file is ingested \* \`omnichannel_subscription_item_pause_scheduled\` - Triggered when an omnichannel subscription item scheduled for pause
              enum:
              - plan_created
              - plan_updated
              - plan_deleted
              - addon_created
              - addon_updated
              - addon_deleted
              - coupon_created
              - coupon_updated
              - coupon_deleted
              - coupon_set_created
              - coupon_set_updated
              - coupon_set_deleted
              - coupon_codes_added
              - coupon_codes_deleted
              - coupon_codes_updated
              - customer_created
              - customer_changed
              - customer_deleted
              - customer_moved_out
              - customer_moved_in
              - promotional_credits_added
              - promotional_credits_deducted
              - subscription_created
              - subscription_created_with_backdating
              - subscription_started
              - subscription_trial_end_reminder
              - subscription_activated
              - subscription_activated_with_backdating
              - subscription_changed
              - subscription_trial_extended
              - mrr_updated
              - subscription_changed_with_backdating
              - subscription_cancellation_scheduled
              - subscription_cancellation_reminder
              - subscription_cancelled
              - subscription_canceled_with_backdating
              - subscription_reactivated
              - subscription_reactivated_with_backdating
              - subscription_renewed
              - subscription_items_renewed
              - subscription_scheduled_cancellation_removed
              - subscription_changes_scheduled
              - subscription_scheduled_changes_removed
              - subscription_shipping_address_updated
              - subscription_deleted
              - subscription_paused
              - subscription_pause_scheduled
              - subscription_scheduled_pause_removed
              - subscription_resumed
              - subscription_resumption_scheduled
              - subscription_scheduled_resumption_removed
              - subscription_advance_invoice_schedule_added
              - subscription_advance_invoice_schedule_updated
              - subscription_advance_invoice_schedule_removed
              - pending_invoice_created
              - pending_invoice_updated
              - invoice_generated
              - invoice_generated_with_backdating
              - invoice_updated
              - invoice_deleted
              - credit_note_created
              - credit_note_created_with_backdating
              - credit_note_updated
              - credit_note_deleted
              - subscription_renewal_reminder
              - transaction_created
              - transaction_updated
              - transaction_deleted
              - payment_succeeded
              - payment_failed
              - dunning_updated
              - payment_refunded
              - payment_initiated
              - refund_initiated
              - authorization_succeeded
              - authorization_voided
              - card_added
              - card_updated
              - card_expiry_reminder
              - card_expired
              - card_deleted
              - payment_source_added
              - payment_source_updated
              - payment_source_deleted
              - payment_source_expiring
              - payment_source_expired
              - payment_source_locally_deleted
              - virtual_bank_account_added
              - virtual_bank_account_updated
              - virtual_bank_account_deleted
              - token_created
              - token_consumed
              - token_expired
              - unbilled_charges_created
              - unbilled_charges_voided
              - unbilled_charges_deleted
              - unbilled_charges_invoiced
              - order_created
              - order_updated
              - order_cancelled
              - order_delivered
              - order_returned
              - order_ready_to_process
              - order_ready_to_ship
              - order_deleted
              - order_resent
              - quote_created
              - quote_updated
              - quote_deleted
              - tax_withheld_recorded
              - tax_withheld_deleted
              - tax_withheld_refunded
              - gift_scheduled
              - gift_unclaimed
              - gift_claimed
              - gift_expired
              - gift_cancelled
              - gift_updated
              - hierarchy_created
              - hierarchy_deleted
              - payment_intent_created
              - payment_intent_updated
              - contract_term_created
              - contract_term_renewed
              - contract_term_terminated
              - contract_term_completed
              - contract_term_cancelled
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - subscription_moved_in
              - subscription_moved_out
              - subscription_movement_failed
              - omnichannel_subscription_created
              - omnichannel_subscription_item_renewed
              - omnichannel_subscription_item_downgraded
              - omnichannel_subscription_item_expired
              - omnichannel_subscription_item_cancellation_scheduled
              - omnichannel_subscription_item_scheduled_cancellation_removed
              - omnichannel_subscription_item_resubscribed
              - omnichannel_subscription_item_upgraded
              - omnichannel_subscription_item_cancelled
              - omnichannel_subscription_imported
              - omnichannel_subscription_item_grace_period_started
              - omnichannel_subscription_item_grace_period_expired
              - omnichannel_subscription_item_dunning_started
              - omnichannel_subscription_item_dunning_expired
              - rule_created
              - rule_updated
              - rule_deleted
              - record_purchase_failed
              - omnichannel_subscription_item_change_scheduled
              - omnichannel_subscription_item_scheduled_change_removed
              - omnichannel_subscription_item_reactivated
              - sales_order_created
              - sales_order_updated
              - omnichannel_subscription_item_changed
              - omnichannel_subscription_item_paused
              - omnichannel_subscription_item_resumed
              - omnichannel_one_time_order_created
              - omnichannel_one_time_order_item_cancelled
              - usage_file_ingested
              - omnichannel_subscription_item_pause_scheduled
              example: null
            is_not:
              type: string
              description: |
                \* \`plan_created\` - Sent when a plan is created. \* \`plan_updated\` - Sent when a plan is changed. \* \`plan_deleted\` - Sent when a plan is deleted. \* \`addon_created\` - Sent when a addon is created. \* \`addon_updated\` - Sent when a addon is changed. \* \`addon_deleted\` - Sent when a addon is deleted. \* \`coupon_created\` - Sent when a coupon is created. \* \`coupon_updated\` - Sent when a coupon is changed. \* \`coupon_deleted\` - Sent when a coupon is deleted. \* \`coupon_set_created\` - Sent when a coupon set is created \* \`coupon_set_updated\` - Sent when a coupon set is changed \* \`coupon_set_deleted\` - Sent when a coupon set is deleted \* \`coupon_codes_added\` - Sent when coupon codes are added in coupon set \* \`coupon_codes_deleted\` - Sent when coupon codes are deleted in coupon set \* \`coupon_codes_updated\` - Sent when coupon codes are updated \* \`customer_created\` - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation. \* \`customer_changed\` - Sent when a customer is changed \* \`customer_deleted\` - Sent when a customer is deleted \* \`customer_moved_out\` - Sent when a customer is copied to another site \* \`customer_moved_in\` - Sent when a customer is copied from another site \* \`promotional_credits_added\` - Sent when a customer prmotion credits added \* \`promotional_credits_deducted\` - Sent when a customer prmotion credits deducted \* \`subscription_created\` - Sent when a new subscription is created. \* \`subscription_created_with_backdating\` - Sent when a new subscription is created with backdating. \* \`subscription_started\` - Sent when a 'future' subscription gets started at the scheduled date. \* \`subscription_trial_end_reminder\` - Sent when the customer's trial period is about to end. \* \`subscription_activated\` - Sent after the subscription has been moved from trial to active state \* \`subscription_activated_with_backdating\` - Sent after the subscription changes to \`active\` from another \`status\`, while the change is backdated. \* \`subscription_changed\` - Sent after the subscription's recurring items have been changed \* \`subscription_trial_extended\` - Trial Extension \* \`mrr_updated\` - Sent when either of MRR or CMRR of a subscription changes \* \`subscription_changed_with_backdating\` - Sent after the subscription's recurring items have been changed with backdated date \* \`subscription_cancellation_scheduled\` - Sent when subscription is scheduled to cancel at end of current term \* \`subscription_cancellation_reminder\` - Sent when the customer's subscription is nearing it's scheduled cancellation date. \* \`subscription_cancelled\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_canceled_with_backdating\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_reactivated\` - Sent when the subscription is moved from cancelled state to active or in_trial state \* \`subscription_reactivated_with_backdating\` - Sent when the subscription is moved from cancelled state to active or in_trial state with past date \* \`subscription_renewed\` - Sent when the subscription is renewed from the current term. \* \`subscription_items_renewed\` - Sent when one or more Subscription Items are renewed \* \`subscription_scheduled_cancellation_removed\` - Sent when scheduled cancellation is removed for the subscription. \* \`subscription_changes_scheduled\` - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term. \* \`subscription_scheduled_changes_removed\` - Sent when scheduled change for the subscription is removed. \* \`subscription_shipping_address_updated\` - Triggered when shipping address is added or updated for a subscription. \* \`subscription_deleted\` - Sent when a subscription has been deleted \* \`subscription_paused\` - Sent when the subscription is paused. \* \`subscription_pause_scheduled\` - Sent when the subscription is scheduled to pause. \* \`subscription_scheduled_pause_removed\` - Triggered when scheduled pause is removed for the subscription. \* \`subscription_resumed\` - Sent when the subscription is moved from paused state to active state \* \`subscription_resumption_scheduled\` - Triggered when the subscription resumption is scheduled. \* \`subscription_scheduled_resumption_removed\` - Triggered when scheduled resumption is removed for the subscription. \* \`subscription_advance_invoice_schedule_added\` - Triggered when advance invoice is scheduled for a subscription. \* \`subscription_advance_invoice_schedule_updated\` - Triggered when scheduled advance invoice is updated for a subscription. \* \`subscription_advance_invoice_schedule_removed\` - Triggered when scheduled advance invoice is removed for a subscription. \* \`pending_invoice_created\` - Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled. \* \`pending_invoice_updated\` - Event triggered when the option "Notify and wait to close invoices" is enabled, and the 'Pending' invoice is updated. \* \`invoice_generated\` - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed. \* \`invoice_generated_with_backdating\` - Event triggered when a new invoice is generated with past date as invoice date. \* \`invoice_updated\` - Triggered when the invoice's shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed. \* \`invoice_deleted\` - Event triggered when an invoice is deleted. \* \`credit_note_created\` - Sent when a credit note is created \* \`credit_note_created_with_backdating\` - Sent when a credit note is created with past date as credit note date \* \`credit_note_updated\` - Sent when a credit note is updated \* \`credit_note_deleted\` - Sent when a credit note is deleted \* \`subscription_renewal_reminder\` - Sent before each subscription's renewal based on plan's period \* \`transaction_created\` - Triggered when a transaction is recorded \* \`transaction_updated\` - Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated. \* \`transaction_deleted\` - Triggered when a transaction is deleted. \* \`payment_succeeded\` - Sent when the payment is successfully collected \* \`payment_failed\` - Sent when attempt to charge customer's credit card fails \* \`dunning_updated\` - Sent when dunning is paused for an invoice \* \`payment_refunded\` - Sent when a payment refund is made \* \`payment_initiated\` - Sent when a payment is initiated via direct debit \* \`refund_initiated\` - Sent when a refund is initiated via direct debit \* \`netd_payment_due_reminder\` - \*\*(Deprecated)\*\* Sent when a invoice's due period is about to end \* \`authorization_succeeded\` - Triggered when a authorization transaction is created. \* \`authorization_voided\` - Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time. \* \`card_added\` - Sent when a card is added for a customer. \* \`card_updated\` - Sent when the card is updated for a customer. \* \`card_expiry_reminder\` - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date. \* \`card_expired\` - Sent when a card for a customer is expired \* \`card_deleted\` - Sent when a card is deleted for a customer \* \`payment_source_added\` - Sent when a payment source is added for a customer. \* \`payment_source_updated\` - Sent when the payment source is updated for a customer or when role is assigned to the payment source. \* \`payment_source_deleted\` - Sent when a payment source is deleted for a customer \* \`payment_source_expiring\` - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date. \* \`payment_source_expired\` - Sent when a payment source for a customer is expired \* \`payment_source_locally_deleted\` - Sent when a payment source for a customer removed from Chargebee \* \`virtual_bank_account_added\` - Sent when a virtual bank account is added for a customer. \* \`virtual_bank_account_updated\` - Sent when the virtual bank account is updated for a customer. \* \`virtual_bank_account_deleted\` - Sent when a virtual bank account is deleted for a customer. \* \`token_created\` - Sent when a Token is created \* \`token_consumed\` - Sent when a Token is consumed \* \`token_expired\` - Sent when a Token is expired \* \`unbilled_charges_created\` - Triggered when unbilled charges are created \* \`unbilled_charges_voided\` - Triggered when unbilled charges are voided \* \`unbilled_charges_deleted\` - Triggered when unbilled charges are deleted \* \`unbilled_charges_invoiced\` - Triggered when unbilled charges are invoiced \* \`order_created\` - Triggered when order is created \* \`order_updated\` - Triggered when order is updated \* \`order_cancelled\` - Triggered when order is cancelled \* \`order_delivered\` - Triggered when order is marked as delivered \* \`order_returned\` - Triggered when order is marked as returned \* \`order_ready_to_process\` - Triggered when order reaches it's order date \* \`order_ready_to_ship\` - Triggered when order reaches it's shipping date \* \`order_deleted\` - Triggered when order is deleted \* \`order_resent\` - Triggered when order is resent \* \`quote_created\` - Triggered when quote is created \* \`quote_updated\` - Triggered when quote is updated \* \`quote_deleted\` - Triggered when quote is deleted \* \`tax_withheld_recorded\` - Triggered when a tax withheld is recorded for an invoice \* \`tax_withheld_deleted\` - Triggered when a tax withheld is deleted \* \`tax_withheld_refunded\` - Sent when a tax withheld refund is made \* \`gift_scheduled\` - Triggered when a new gift is created \* \`gift_unclaimed\` - Triggered when a new gift is unclaimed and is ready to be claimed \* \`gift_claimed\` - Triggered when a gift is claimed \* \`gift_expired\` - Triggered when a gift expires \* \`gift_cancelled\` - Triggered when a gift is cancelled. \* \`gift_updated\` - Triggered when a gift is updated \* \`hierarchy_created\` - Triggered when a hierarchy is created \* \`hierarchy_deleted\` - Triggered when a hierarchy is deleted \* \`payment_intent_created\` - Sent when a Payment intent is created \* \`payment_intent_updated\` - Sent when a Payment intent is updated \* \`contract_term_created\` - Triggered when new contract term is created \* \`contract_term_renewed\` - Triggered when new contract term is renewed \* \`contract_term_terminated\` - Triggered when contract term is terminated \* \`contract_term_completed\` - Triggered when contract term is completed \* \`contract_term_cancelled\` - Triggered when contract term is cancelled \* \`voucher_created\` - Triggered when a payment voucher is created \* \`voucher_expired\` - Triggered when a payment voucher is expired \* \`voucher_create_failed\` - Triggered when a payment voucher creation is failed \* \`subscription_ramp_created\` - Triggered when a subscription ramp is created. \* \`subscription_ramp_deleted\` - Triggered when a subscription ramp is deleted. \* \`subscription_ramp_applied\` - Triggered when a subscription ramp is applied. \* \`subscription_ramp_drafted\` - Triggered when a subscription ramp is moved to draft status. \* \`subscription_ramp_updated\` - Triggered when a subscription ramp is updated. \* \`subscription_moved_in\` - Triggered when a subscription moved from other customer \* \`subscription_moved_out\` - Triggered when a subscription moved to other customer \* \`subscription_movement_failed\` - Triggered when a subscription movement failed \* \`omnichannel_subscription_created\` - Triggered when an omnichannel subscription is created \* \`omnichannel_subscription_item_renewed\` - Triggered when an omnichannel subscription item is renewed \* \`omnichannel_subscription_item_downgrade_scheduled\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item is downgrade is scheduled \* \`omnichannel_subscription_item_scheduled_downgrade_removed\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item scheduled downgrade is removed \* \`omnichannel_subscription_item_downgraded\` - Triggered when an omnichannel subscription item is downgraded \* \`omnichannel_subscription_item_expired\` - Triggered when an omnichannel subscription item is expired \* \`omnichannel_subscription_item_cancellation_scheduled\` - Triggered when an omnichannel subscription item is scheduled for cancellation \* \`omnichannel_subscription_item_scheduled_cancellation_removed\` - Triggered when an omnichannel subscription item scheduled cancellation is removed \* \`omnichannel_subscription_item_resubscribed\` - Triggered when an omnichannel subscription item is resubscribed \* \`omnichannel_subscription_item_upgraded\` - Triggered when an omnichannel subscription item is upgraded \* \`omnichannel_subscription_item_cancelled\` - Triggered when an omnichannel subscription item is cancelled \* \`omnichannel_subscription_imported\` - Triggered when an omnichannel subscription item is imported \* \`omnichannel_subscription_item_grace_period_started\` - Triggered when an omnichannel subscription item's grace period has started \* \`omnichannel_subscription_item_grace_period_expired\` - Triggered when an omnichannel subscription item's grace period has expired \* \`omnichannel_subscription_item_dunning_started\` - Triggered when an omnichannel subscription item's dunning has started \* \`omnichannel_subscription_item_dunning_expired\` - Triggered when an omnichannel subscription item's dunning has expired \* \`rule_created\` - Triggered when a rule is created \* \`rule_updated\` - Triggered when a rule is updated \* \`rule_deleted\` - Triggered when a rule is deleted \* \`record_purchase_failed\` - Triggered when an omnichannel record purchase is failed \* \`omnichannel_subscription_item_change_scheduled\` - Triggered when an omnichannel subscription item change is scheduled \* \`omnichannel_subscription_item_scheduled_change_removed\` - Triggered when an omnichannel subscription item scheduled change is removed \* \`omnichannel_subscription_item_reactivated\` - Triggered when an omnichannel subscription item's refund is reversed \* \`sales_order_created\` - Triggered when sales order is created \* \`sales_order_updated\` - Triggered when sales order is updated \* \`omnichannel_subscription_item_changed\` - Triggered when an omnichannel subscription item is changed \* \`omnichannel_subscription_item_paused\` - Triggered when an omnichannel subscription item is paused \* \`omnichannel_subscription_item_resumed\` - Triggered when an omnichannel subscription item is resumed \* \`omnichannel_one_time_order_created\` - Triggered when an omnichannel one time order is created \* \`omnichannel_one_time_order_item_cancelled\` - Triggered when an omnichannel one time order item is cancelled \* \`usage_file_ingested\` - Triggered when a usage file is ingested \* \`omnichannel_subscription_item_pause_scheduled\` - Triggered when an omnichannel subscription item scheduled for pause
              enum:
              - plan_created
              - plan_updated
              - plan_deleted
              - addon_created
              - addon_updated
              - addon_deleted
              - coupon_created
              - coupon_updated
              - coupon_deleted
              - coupon_set_created
              - coupon_set_updated
              - coupon_set_deleted
              - coupon_codes_added
              - coupon_codes_deleted
              - coupon_codes_updated
              - customer_created
              - customer_changed
              - customer_deleted
              - customer_moved_out
              - customer_moved_in
              - promotional_credits_added
              - promotional_credits_deducted
              - subscription_created
              - subscription_created_with_backdating
              - subscription_started
              - subscription_trial_end_reminder
              - subscription_activated
              - subscription_activated_with_backdating
              - subscription_changed
              - subscription_trial_extended
              - mrr_updated
              - subscription_changed_with_backdating
              - subscription_cancellation_scheduled
              - subscription_cancellation_reminder
              - subscription_cancelled
              - subscription_canceled_with_backdating
              - subscription_reactivated
              - subscription_reactivated_with_backdating
              - subscription_renewed
              - subscription_items_renewed
              - subscription_scheduled_cancellation_removed
              - subscription_changes_scheduled
              - subscription_scheduled_changes_removed
              - subscription_shipping_address_updated
              - subscription_deleted
              - subscription_paused
              - subscription_pause_scheduled
              - subscription_scheduled_pause_removed
              - subscription_resumed
              - subscription_resumption_scheduled
              - subscription_scheduled_resumption_removed
              - subscription_advance_invoice_schedule_added
              - subscription_advance_invoice_schedule_updated
              - subscription_advance_invoice_schedule_removed
              - pending_invoice_created
              - pending_invoice_updated
              - invoice_generated
              - invoice_generated_with_backdating
              - invoice_updated
              - invoice_deleted
              - credit_note_created
              - credit_note_created_with_backdating
              - credit_note_updated
              - credit_note_deleted
              - subscription_renewal_reminder
              - transaction_created
              - transaction_updated
              - transaction_deleted
              - payment_succeeded
              - payment_failed
              - dunning_updated
              - payment_refunded
              - payment_initiated
              - refund_initiated
              - authorization_succeeded
              - authorization_voided
              - card_added
              - card_updated
              - card_expiry_reminder
              - card_expired
              - card_deleted
              - payment_source_added
              - payment_source_updated
              - payment_source_deleted
              - payment_source_expiring
              - payment_source_expired
              - payment_source_locally_deleted
              - virtual_bank_account_added
              - virtual_bank_account_updated
              - virtual_bank_account_deleted
              - token_created
              - token_consumed
              - token_expired
              - unbilled_charges_created
              - unbilled_charges_voided
              - unbilled_charges_deleted
              - unbilled_charges_invoiced
              - order_created
              - order_updated
              - order_cancelled
              - order_delivered
              - order_returned
              - order_ready_to_process
              - order_ready_to_ship
              - order_deleted
              - order_resent
              - quote_created
              - quote_updated
              - quote_deleted
              - tax_withheld_recorded
              - tax_withheld_deleted
              - tax_withheld_refunded
              - gift_scheduled
              - gift_unclaimed
              - gift_claimed
              - gift_expired
              - gift_cancelled
              - gift_updated
              - hierarchy_created
              - hierarchy_deleted
              - payment_intent_created
              - payment_intent_updated
              - contract_term_created
              - contract_term_renewed
              - contract_term_terminated
              - contract_term_completed
              - contract_term_cancelled
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - subscription_moved_in
              - subscription_moved_out
              - subscription_movement_failed
              - omnichannel_subscription_created
              - omnichannel_subscription_item_renewed
              - omnichannel_subscription_item_downgraded
              - omnichannel_subscription_item_expired
              - omnichannel_subscription_item_cancellation_scheduled
              - omnichannel_subscription_item_scheduled_cancellation_removed
              - omnichannel_subscription_item_resubscribed
              - omnichannel_subscription_item_upgraded
              - omnichannel_subscription_item_cancelled
              - omnichannel_subscription_imported
              - omnichannel_subscription_item_grace_period_started
              - omnichannel_subscription_item_grace_period_expired
              - omnichannel_subscription_item_dunning_started
              - omnichannel_subscription_item_dunning_expired
              - rule_created
              - rule_updated
              - rule_deleted
              - record_purchase_failed
              - omnichannel_subscription_item_change_scheduled
              - omnichannel_subscription_item_scheduled_change_removed
              - omnichannel_subscription_item_reactivated
              - sales_order_created
              - sales_order_updated
              - omnichannel_subscription_item_changed
              - omnichannel_subscription_item_paused
              - omnichannel_subscription_item_resumed
              - omnichannel_one_time_order_created
              - omnichannel_one_time_order_item_cancelled
              - usage_file_ingested
              - omnichannel_subscription_item_pause_scheduled
              example: null
            in:
              type: string
              description: |
                \* \`plan_created\` - Sent when a plan is created. \* \`plan_updated\` - Sent when a plan is changed. \* \`plan_deleted\` - Sent when a plan is deleted. \* \`addon_created\` - Sent when a addon is created. \* \`addon_updated\` - Sent when a addon is changed. \* \`addon_deleted\` - Sent when a addon is deleted. \* \`coupon_created\` - Sent when a coupon is created. \* \`coupon_updated\` - Sent when a coupon is changed. \* \`coupon_deleted\` - Sent when a coupon is deleted. \* \`coupon_set_created\` - Sent when a coupon set is created \* \`coupon_set_updated\` - Sent when a coupon set is changed \* \`coupon_set_deleted\` - Sent when a coupon set is deleted \* \`coupon_codes_added\` - Sent when coupon codes are added in coupon set \* \`coupon_codes_deleted\` - Sent when coupon codes are deleted in coupon set \* \`coupon_codes_updated\` - Sent when coupon codes are updated \* \`customer_created\` - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation. \* \`customer_changed\` - Sent when a customer is changed \* \`customer_deleted\` - Sent when a customer is deleted \* \`customer_moved_out\` - Sent when a customer is copied to another site \* \`customer_moved_in\` - Sent when a customer is copied from another site \* \`promotional_credits_added\` - Sent when a customer prmotion credits added \* \`promotional_credits_deducted\` - Sent when a customer prmotion credits deducted \* \`subscription_created\` - Sent when a new subscription is created. \* \`subscription_created_with_backdating\` - Sent when a new subscription is created with backdating. \* \`subscription_started\` - Sent when a 'future' subscription gets started at the scheduled date. \* \`subscription_trial_end_reminder\` - Sent when the customer's trial period is about to end. \* \`subscription_activated\` - Sent after the subscription has been moved from trial to active state \* \`subscription_activated_with_backdating\` - Sent after the subscription changes to \`active\` from another \`status\`, while the change is backdated. \* \`subscription_changed\` - Sent after the subscription's recurring items have been changed \* \`subscription_trial_extended\` - Trial Extension \* \`mrr_updated\` - Sent when either of MRR or CMRR of a subscription changes \* \`subscription_changed_with_backdating\` - Sent after the subscription's recurring items have been changed with backdated date \* \`subscription_cancellation_scheduled\` - Sent when subscription is scheduled to cancel at end of current term \* \`subscription_cancellation_reminder\` - Sent when the customer's subscription is nearing it's scheduled cancellation date. \* \`subscription_cancelled\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_canceled_with_backdating\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_reactivated\` - Sent when the subscription is moved from cancelled state to active or in_trial state \* \`subscription_reactivated_with_backdating\` - Sent when the subscription is moved from cancelled state to active or in_trial state with past date \* \`subscription_renewed\` - Sent when the subscription is renewed from the current term. \* \`subscription_items_renewed\` - Sent when one or more Subscription Items are renewed \* \`subscription_scheduled_cancellation_removed\` - Sent when scheduled cancellation is removed for the subscription. \* \`subscription_changes_scheduled\` - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term. \* \`subscription_scheduled_changes_removed\` - Sent when scheduled change for the subscription is removed. \* \`subscription_shipping_address_updated\` - Triggered when shipping address is added or updated for a subscription. \* \`subscription_deleted\` - Sent when a subscription has been deleted \* \`subscription_paused\` - Sent when the subscription is paused. \* \`subscription_pause_scheduled\` - Sent when the subscription is scheduled to pause. \* \`subscription_scheduled_pause_removed\` - Triggered when scheduled pause is removed for the subscription. \* \`subscription_resumed\` - Sent when the subscription is moved from paused state to active state \* \`subscription_resumption_scheduled\` - Triggered when the subscription resumption is scheduled. \* \`subscription_scheduled_resumption_removed\` - Triggered when scheduled resumption is removed for the subscription. \* \`subscription_advance_invoice_schedule_added\` - Triggered when advance invoice is scheduled for a subscription. \* \`subscription_advance_invoice_schedule_updated\` - Triggered when scheduled advance invoice is updated for a subscription. \* \`subscription_advance_invoice_schedule_removed\` - Triggered when scheduled advance invoice is removed for a subscription. \* \`pending_invoice_created\` - Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled. \* \`pending_invoice_updated\` - Event triggered when the option "Notify and wait to close invoices" is enabled, and the 'Pending' invoice is updated. \* \`invoice_generated\` - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed. \* \`invoice_generated_with_backdating\` - Event triggered when a new invoice is generated with past date as invoice date. \* \`invoice_updated\` - Triggered when the invoice's shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed. \* \`invoice_deleted\` - Event triggered when an invoice is deleted. \* \`credit_note_created\` - Sent when a credit note is created \* \`credit_note_created_with_backdating\` - Sent when a credit note is created with past date as credit note date \* \`credit_note_updated\` - Sent when a credit note is updated \* \`credit_note_deleted\` - Sent when a credit note is deleted \* \`subscription_renewal_reminder\` - Sent before each subscription's renewal based on plan's period \* \`transaction_created\` - Triggered when a transaction is recorded \* \`transaction_updated\` - Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated. \* \`transaction_deleted\` - Triggered when a transaction is deleted. \* \`payment_succeeded\` - Sent when the payment is successfully collected \* \`payment_failed\` - Sent when attempt to charge customer's credit card fails \* \`dunning_updated\` - Sent when dunning is paused for an invoice \* \`payment_refunded\` - Sent when a payment refund is made \* \`payment_initiated\` - Sent when a payment is initiated via direct debit \* \`refund_initiated\` - Sent when a refund is initiated via direct debit \* \`netd_payment_due_reminder\` - \*\*(Deprecated)\*\* Sent when a invoice's due period is about to end \* \`authorization_succeeded\` - Triggered when a authorization transaction is created. \* \`authorization_voided\` - Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time. \* \`card_added\` - Sent when a card is added for a customer. \* \`card_updated\` - Sent when the card is updated for a customer. \* \`card_expiry_reminder\` - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date. \* \`card_expired\` - Sent when a card for a customer is expired \* \`card_deleted\` - Sent when a card is deleted for a customer \* \`payment_source_added\` - Sent when a payment source is added for a customer. \* \`payment_source_updated\` - Sent when the payment source is updated for a customer or when role is assigned to the payment source. \* \`payment_source_deleted\` - Sent when a payment source is deleted for a customer \* \`payment_source_expiring\` - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date. \* \`payment_source_expired\` - Sent when a payment source for a customer is expired \* \`payment_source_locally_deleted\` - Sent when a payment source for a customer removed from Chargebee \* \`virtual_bank_account_added\` - Sent when a virtual bank account is added for a customer. \* \`virtual_bank_account_updated\` - Sent when the virtual bank account is updated for a customer. \* \`virtual_bank_account_deleted\` - Sent when a virtual bank account is deleted for a customer. \* \`token_created\` - Sent when a Token is created \* \`token_consumed\` - Sent when a Token is consumed \* \`token_expired\` - Sent when a Token is expired \* \`unbilled_charges_created\` - Triggered when unbilled charges are created \* \`unbilled_charges_voided\` - Triggered when unbilled charges are voided \* \`unbilled_charges_deleted\` - Triggered when unbilled charges are deleted \* \`unbilled_charges_invoiced\` - Triggered when unbilled charges are invoiced \* \`order_created\` - Triggered when order is created \* \`order_updated\` - Triggered when order is updated \* \`order_cancelled\` - Triggered when order is cancelled \* \`order_delivered\` - Triggered when order is marked as delivered \* \`order_returned\` - Triggered when order is marked as returned \* \`order_ready_to_process\` - Triggered when order reaches it's order date \* \`order_ready_to_ship\` - Triggered when order reaches it's shipping date \* \`order_deleted\` - Triggered when order is deleted \* \`order_resent\` - Triggered when order is resent \* \`quote_created\` - Triggered when quote is created \* \`quote_updated\` - Triggered when quote is updated \* \`quote_deleted\` - Triggered when quote is deleted \* \`tax_withheld_recorded\` - Triggered when a tax withheld is recorded for an invoice \* \`tax_withheld_deleted\` - Triggered when a tax withheld is deleted \* \`tax_withheld_refunded\` - Sent when a tax withheld refund is made \* \`gift_scheduled\` - Triggered when a new gift is created \* \`gift_unclaimed\` - Triggered when a new gift is unclaimed and is ready to be claimed \* \`gift_claimed\` - Triggered when a gift is claimed \* \`gift_expired\` - Triggered when a gift expires \* \`gift_cancelled\` - Triggered when a gift is cancelled. \* \`gift_updated\` - Triggered when a gift is updated \* \`hierarchy_created\` - Triggered when a hierarchy is created \* \`hierarchy_deleted\` - Triggered when a hierarchy is deleted \* \`payment_intent_created\` - Sent when a Payment intent is created \* \`payment_intent_updated\` - Sent when a Payment intent is updated \* \`contract_term_created\` - Triggered when new contract term is created \* \`contract_term_renewed\` - Triggered when new contract term is renewed \* \`contract_term_terminated\` - Triggered when contract term is terminated \* \`contract_term_completed\` - Triggered when contract term is completed \* \`contract_term_cancelled\` - Triggered when contract term is cancelled \* \`voucher_created\` - Triggered when a payment voucher is created \* \`voucher_expired\` - Triggered when a payment voucher is expired \* \`voucher_create_failed\` - Triggered when a payment voucher creation is failed \* \`subscription_ramp_created\` - Triggered when a subscription ramp is created. \* \`subscription_ramp_deleted\` - Triggered when a subscription ramp is deleted. \* \`subscription_ramp_applied\` - Triggered when a subscription ramp is applied. \* \`subscription_ramp_drafted\` - Triggered when a subscription ramp is moved to draft status. \* \`subscription_ramp_updated\` - Triggered when a subscription ramp is updated. \* \`subscription_moved_in\` - Triggered when a subscription moved from other customer \* \`subscription_moved_out\` - Triggered when a subscription moved to other customer \* \`subscription_movement_failed\` - Triggered when a subscription movement failed \* \`omnichannel_subscription_created\` - Triggered when an omnichannel subscription is created \* \`omnichannel_subscription_item_renewed\` - Triggered when an omnichannel subscription item is renewed \* \`omnichannel_subscription_item_downgrade_scheduled\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item is downgrade is scheduled \* \`omnichannel_subscription_item_scheduled_downgrade_removed\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item scheduled downgrade is removed \* \`omnichannel_subscription_item_downgraded\` - Triggered when an omnichannel subscription item is downgraded \* \`omnichannel_subscription_item_expired\` - Triggered when an omnichannel subscription item is expired \* \`omnichannel_subscription_item_cancellation_scheduled\` - Triggered when an omnichannel subscription item is scheduled for cancellation \* \`omnichannel_subscription_item_scheduled_cancellation_removed\` - Triggered when an omnichannel subscription item scheduled cancellation is removed \* \`omnichannel_subscription_item_resubscribed\` - Triggered when an omnichannel subscription item is resubscribed \* \`omnichannel_subscription_item_upgraded\` - Triggered when an omnichannel subscription item is upgraded \* \`omnichannel_subscription_item_cancelled\` - Triggered when an omnichannel subscription item is cancelled \* \`omnichannel_subscription_imported\` - Triggered when an omnichannel subscription item is imported \* \`omnichannel_subscription_item_grace_period_started\` - Triggered when an omnichannel subscription item's grace period has started \* \`omnichannel_subscription_item_grace_period_expired\` - Triggered when an omnichannel subscription item's grace period has expired \* \`omnichannel_subscription_item_dunning_started\` - Triggered when an omnichannel subscription item's dunning has started \* \`omnichannel_subscription_item_dunning_expired\` - Triggered when an omnichannel subscription item's dunning has expired \* \`rule_created\` - Triggered when a rule is created \* \`rule_updated\` - Triggered when a rule is updated \* \`rule_deleted\` - Triggered when a rule is deleted \* \`record_purchase_failed\` - Triggered when an omnichannel record purchase is failed \* \`omnichannel_subscription_item_change_scheduled\` - Triggered when an omnichannel subscription item change is scheduled \* \`omnichannel_subscription_item_scheduled_change_removed\` - Triggered when an omnichannel subscription item scheduled change is removed \* \`omnichannel_subscription_item_reactivated\` - Triggered when an omnichannel subscription item's refund is reversed \* \`sales_order_created\` - Triggered when sales order is created \* \`sales_order_updated\` - Triggered when sales order is updated \* \`omnichannel_subscription_item_changed\` - Triggered when an omnichannel subscription item is changed \* \`omnichannel_subscription_item_paused\` - Triggered when an omnichannel subscription item is paused \* \`omnichannel_subscription_item_resumed\` - Triggered when an omnichannel subscription item is resumed \* \`omnichannel_one_time_order_created\` - Triggered when an omnichannel one time order is created \* \`omnichannel_one_time_order_item_cancelled\` - Triggered when an omnichannel one time order item is cancelled \* \`usage_file_ingested\` - Triggered when a usage file is ingested \* \`omnichannel_subscription_item_pause_scheduled\` - Triggered when an omnichannel subscription item scheduled for pause
              enum:
              - plan_created
              - plan_updated
              - plan_deleted
              - addon_created
              - addon_updated
              - addon_deleted
              - coupon_created
              - coupon_updated
              - coupon_deleted
              - coupon_set_created
              - coupon_set_updated
              - coupon_set_deleted
              - coupon_codes_added
              - coupon_codes_deleted
              - coupon_codes_updated
              - customer_created
              - customer_changed
              - customer_deleted
              - customer_moved_out
              - customer_moved_in
              - promotional_credits_added
              - promotional_credits_deducted
              - subscription_created
              - subscription_created_with_backdating
              - subscription_started
              - subscription_trial_end_reminder
              - subscription_activated
              - subscription_activated_with_backdating
              - subscription_changed
              - subscription_trial_extended
              - mrr_updated
              - subscription_changed_with_backdating
              - subscription_cancellation_scheduled
              - subscription_cancellation_reminder
              - subscription_cancelled
              - subscription_canceled_with_backdating
              - subscription_reactivated
              - subscription_reactivated_with_backdating
              - subscription_renewed
              - subscription_items_renewed
              - subscription_scheduled_cancellation_removed
              - subscription_changes_scheduled
              - subscription_scheduled_changes_removed
              - subscription_shipping_address_updated
              - subscription_deleted
              - subscription_paused
              - subscription_pause_scheduled
              - subscription_scheduled_pause_removed
              - subscription_resumed
              - subscription_resumption_scheduled
              - subscription_scheduled_resumption_removed
              - subscription_advance_invoice_schedule_added
              - subscription_advance_invoice_schedule_updated
              - subscription_advance_invoice_schedule_removed
              - pending_invoice_created
              - pending_invoice_updated
              - invoice_generated
              - invoice_generated_with_backdating
              - invoice_updated
              - invoice_deleted
              - credit_note_created
              - credit_note_created_with_backdating
              - credit_note_updated
              - credit_note_deleted
              - subscription_renewal_reminder
              - transaction_created
              - transaction_updated
              - transaction_deleted
              - payment_succeeded
              - payment_failed
              - dunning_updated
              - payment_refunded
              - payment_initiated
              - refund_initiated
              - authorization_succeeded
              - authorization_voided
              - card_added
              - card_updated
              - card_expiry_reminder
              - card_expired
              - card_deleted
              - payment_source_added
              - payment_source_updated
              - payment_source_deleted
              - payment_source_expiring
              - payment_source_expired
              - payment_source_locally_deleted
              - virtual_bank_account_added
              - virtual_bank_account_updated
              - virtual_bank_account_deleted
              - token_created
              - token_consumed
              - token_expired
              - unbilled_charges_created
              - unbilled_charges_voided
              - unbilled_charges_deleted
              - unbilled_charges_invoiced
              - order_created
              - order_updated
              - order_cancelled
              - order_delivered
              - order_returned
              - order_ready_to_process
              - order_ready_to_ship
              - order_deleted
              - order_resent
              - quote_created
              - quote_updated
              - quote_deleted
              - tax_withheld_recorded
              - tax_withheld_deleted
              - tax_withheld_refunded
              - gift_scheduled
              - gift_unclaimed
              - gift_claimed
              - gift_expired
              - gift_cancelled
              - gift_updated
              - hierarchy_created
              - hierarchy_deleted
              - payment_intent_created
              - payment_intent_updated
              - contract_term_created
              - contract_term_renewed
              - contract_term_terminated
              - contract_term_completed
              - contract_term_cancelled
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - subscription_moved_in
              - subscription_moved_out
              - subscription_movement_failed
              - omnichannel_subscription_created
              - omnichannel_subscription_item_renewed
              - omnichannel_subscription_item_downgraded
              - omnichannel_subscription_item_expired
              - omnichannel_subscription_item_cancellation_scheduled
              - omnichannel_subscription_item_scheduled_cancellation_removed
              - omnichannel_subscription_item_resubscribed
              - omnichannel_subscription_item_upgraded
              - omnichannel_subscription_item_cancelled
              - omnichannel_subscription_imported
              - omnichannel_subscription_item_grace_period_started
              - omnichannel_subscription_item_grace_period_expired
              - omnichannel_subscription_item_dunning_started
              - omnichannel_subscription_item_dunning_expired
              - rule_created
              - rule_updated
              - rule_deleted
              - record_purchase_failed
              - omnichannel_subscription_item_change_scheduled
              - omnichannel_subscription_item_scheduled_change_removed
              - omnichannel_subscription_item_reactivated
              - sales_order_created
              - sales_order_updated
              - omnichannel_subscription_item_changed
              - omnichannel_subscription_item_paused
              - omnichannel_subscription_item_resumed
              - omnichannel_one_time_order_created
              - omnichannel_one_time_order_item_cancelled
              - usage_file_ingested
              - omnichannel_subscription_item_pause_scheduled
              pattern: "^\\[(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|usage_file_ingested|omnichannel_subscription_item_pause_scheduled)(,(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|usage_file_ingested|omnichannel_subscription_item_pause_scheduled))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`plan_created\` - Sent when a plan is created. \* \`plan_updated\` - Sent when a plan is changed. \* \`plan_deleted\` - Sent when a plan is deleted. \* \`addon_created\` - Sent when a addon is created. \* \`addon_updated\` - Sent when a addon is changed. \* \`addon_deleted\` - Sent when a addon is deleted. \* \`coupon_created\` - Sent when a coupon is created. \* \`coupon_updated\` - Sent when a coupon is changed. \* \`coupon_deleted\` - Sent when a coupon is deleted. \* \`coupon_set_created\` - Sent when a coupon set is created \* \`coupon_set_updated\` - Sent when a coupon set is changed \* \`coupon_set_deleted\` - Sent when a coupon set is deleted \* \`coupon_codes_added\` - Sent when coupon codes are added in coupon set \* \`coupon_codes_deleted\` - Sent when coupon codes are deleted in coupon set \* \`coupon_codes_updated\` - Sent when coupon codes are updated \* \`customer_created\` - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation. \* \`customer_changed\` - Sent when a customer is changed \* \`customer_deleted\` - Sent when a customer is deleted \* \`customer_moved_out\` - Sent when a customer is copied to another site \* \`customer_moved_in\` - Sent when a customer is copied from another site \* \`promotional_credits_added\` - Sent when a customer prmotion credits added \* \`promotional_credits_deducted\` - Sent when a customer prmotion credits deducted \* \`subscription_created\` - Sent when a new subscription is created. \* \`subscription_created_with_backdating\` - Sent when a new subscription is created with backdating. \* \`subscription_started\` - Sent when a 'future' subscription gets started at the scheduled date. \* \`subscription_trial_end_reminder\` - Sent when the customer's trial period is about to end. \* \`subscription_activated\` - Sent after the subscription has been moved from trial to active state \* \`subscription_activated_with_backdating\` - Sent after the subscription changes to \`active\` from another \`status\`, while the change is backdated. \* \`subscription_changed\` - Sent after the subscription's recurring items have been changed \* \`subscription_trial_extended\` - Trial Extension \* \`mrr_updated\` - Sent when either of MRR or CMRR of a subscription changes \* \`subscription_changed_with_backdating\` - Sent after the subscription's recurring items have been changed with backdated date \* \`subscription_cancellation_scheduled\` - Sent when subscription is scheduled to cancel at end of current term \* \`subscription_cancellation_reminder\` - Sent when the customer's subscription is nearing it's scheduled cancellation date. \* \`subscription_cancelled\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_canceled_with_backdating\` - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'. \* \`subscription_reactivated\` - Sent when the subscription is moved from cancelled state to active or in_trial state \* \`subscription_reactivated_with_backdating\` - Sent when the subscription is moved from cancelled state to active or in_trial state with past date \* \`subscription_renewed\` - Sent when the subscription is renewed from the current term. \* \`subscription_items_renewed\` - Sent when one or more Subscription Items are renewed \* \`subscription_scheduled_cancellation_removed\` - Sent when scheduled cancellation is removed for the subscription. \* \`subscription_changes_scheduled\` - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term. \* \`subscription_scheduled_changes_removed\` - Sent when scheduled change for the subscription is removed. \* \`subscription_shipping_address_updated\` - Triggered when shipping address is added or updated for a subscription. \* \`subscription_deleted\` - Sent when a subscription has been deleted \* \`subscription_paused\` - Sent when the subscription is paused. \* \`subscription_pause_scheduled\` - Sent when the subscription is scheduled to pause. \* \`subscription_scheduled_pause_removed\` - Triggered when scheduled pause is removed for the subscription. \* \`subscription_resumed\` - Sent when the subscription is moved from paused state to active state \* \`subscription_resumption_scheduled\` - Triggered when the subscription resumption is scheduled. \* \`subscription_scheduled_resumption_removed\` - Triggered when scheduled resumption is removed for the subscription. \* \`subscription_advance_invoice_schedule_added\` - Triggered when advance invoice is scheduled for a subscription. \* \`subscription_advance_invoice_schedule_updated\` - Triggered when scheduled advance invoice is updated for a subscription. \* \`subscription_advance_invoice_schedule_removed\` - Triggered when scheduled advance invoice is removed for a subscription. \* \`pending_invoice_created\` - Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled. \* \`pending_invoice_updated\` - Event triggered when the option "Notify and wait to close invoices" is enabled, and the 'Pending' invoice is updated. \* \`invoice_generated\` - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed. \* \`invoice_generated_with_backdating\` - Event triggered when a new invoice is generated with past date as invoice date. \* \`invoice_updated\` - Triggered when the invoice's shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed. \* \`invoice_deleted\` - Event triggered when an invoice is deleted. \* \`credit_note_created\` - Sent when a credit note is created \* \`credit_note_created_with_backdating\` - Sent when a credit note is created with past date as credit note date \* \`credit_note_updated\` - Sent when a credit note is updated \* \`credit_note_deleted\` - Sent when a credit note is deleted \* \`subscription_renewal_reminder\` - Sent before each subscription's renewal based on plan's period \* \`transaction_created\` - Triggered when a transaction is recorded \* \`transaction_updated\` - Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated. \* \`transaction_deleted\` - Triggered when a transaction is deleted. \* \`payment_succeeded\` - Sent when the payment is successfully collected \* \`payment_failed\` - Sent when attempt to charge customer's credit card fails \* \`dunning_updated\` - Sent when dunning is paused for an invoice \* \`payment_refunded\` - Sent when a payment refund is made \* \`payment_initiated\` - Sent when a payment is initiated via direct debit \* \`refund_initiated\` - Sent when a refund is initiated via direct debit \* \`netd_payment_due_reminder\` - \*\*(Deprecated)\*\* Sent when a invoice's due period is about to end \* \`authorization_succeeded\` - Triggered when a authorization transaction is created. \* \`authorization_voided\` - Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time. \* \`card_added\` - Sent when a card is added for a customer. \* \`card_updated\` - Sent when the card is updated for a customer. \* \`card_expiry_reminder\` - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date. \* \`card_expired\` - Sent when a card for a customer is expired \* \`card_deleted\` - Sent when a card is deleted for a customer \* \`payment_source_added\` - Sent when a payment source is added for a customer. \* \`payment_source_updated\` - Sent when the payment source is updated for a customer or when role is assigned to the payment source. \* \`payment_source_deleted\` - Sent when a payment source is deleted for a customer \* \`payment_source_expiring\` - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date. \* \`payment_source_expired\` - Sent when a payment source for a customer is expired \* \`payment_source_locally_deleted\` - Sent when a payment source for a customer removed from Chargebee \* \`virtual_bank_account_added\` - Sent when a virtual bank account is added for a customer. \* \`virtual_bank_account_updated\` - Sent when the virtual bank account is updated for a customer. \* \`virtual_bank_account_deleted\` - Sent when a virtual bank account is deleted for a customer. \* \`token_created\` - Sent when a Token is created \* \`token_consumed\` - Sent when a Token is consumed \* \`token_expired\` - Sent when a Token is expired \* \`unbilled_charges_created\` - Triggered when unbilled charges are created \* \`unbilled_charges_voided\` - Triggered when unbilled charges are voided \* \`unbilled_charges_deleted\` - Triggered when unbilled charges are deleted \* \`unbilled_charges_invoiced\` - Triggered when unbilled charges are invoiced \* \`order_created\` - Triggered when order is created \* \`order_updated\` - Triggered when order is updated \* \`order_cancelled\` - Triggered when order is cancelled \* \`order_delivered\` - Triggered when order is marked as delivered \* \`order_returned\` - Triggered when order is marked as returned \* \`order_ready_to_process\` - Triggered when order reaches it's order date \* \`order_ready_to_ship\` - Triggered when order reaches it's shipping date \* \`order_deleted\` - Triggered when order is deleted \* \`order_resent\` - Triggered when order is resent \* \`quote_created\` - Triggered when quote is created \* \`quote_updated\` - Triggered when quote is updated \* \`quote_deleted\` - Triggered when quote is deleted \* \`tax_withheld_recorded\` - Triggered when a tax withheld is recorded for an invoice \* \`tax_withheld_deleted\` - Triggered when a tax withheld is deleted \* \`tax_withheld_refunded\` - Sent when a tax withheld refund is made \* \`gift_scheduled\` - Triggered when a new gift is created \* \`gift_unclaimed\` - Triggered when a new gift is unclaimed and is ready to be claimed \* \`gift_claimed\` - Triggered when a gift is claimed \* \`gift_expired\` - Triggered when a gift expires \* \`gift_cancelled\` - Triggered when a gift is cancelled. \* \`gift_updated\` - Triggered when a gift is updated \* \`hierarchy_created\` - Triggered when a hierarchy is created \* \`hierarchy_deleted\` - Triggered when a hierarchy is deleted \* \`payment_intent_created\` - Sent when a Payment intent is created \* \`payment_intent_updated\` - Sent when a Payment intent is updated \* \`contract_term_created\` - Triggered when new contract term is created \* \`contract_term_renewed\` - Triggered when new contract term is renewed \* \`contract_term_terminated\` - Triggered when contract term is terminated \* \`contract_term_completed\` - Triggered when contract term is completed \* \`contract_term_cancelled\` - Triggered when contract term is cancelled \* \`voucher_created\` - Triggered when a payment voucher is created \* \`voucher_expired\` - Triggered when a payment voucher is expired \* \`voucher_create_failed\` - Triggered when a payment voucher creation is failed \* \`subscription_ramp_created\` - Triggered when a subscription ramp is created. \* \`subscription_ramp_deleted\` - Triggered when a subscription ramp is deleted. \* \`subscription_ramp_applied\` - Triggered when a subscription ramp is applied. \* \`subscription_ramp_drafted\` - Triggered when a subscription ramp is moved to draft status. \* \`subscription_ramp_updated\` - Triggered when a subscription ramp is updated. \* \`subscription_moved_in\` - Triggered when a subscription moved from other customer \* \`subscription_moved_out\` - Triggered when a subscription moved to other customer \* \`subscription_movement_failed\` - Triggered when a subscription movement failed \* \`omnichannel_subscription_created\` - Triggered when an omnichannel subscription is created \* \`omnichannel_subscription_item_renewed\` - Triggered when an omnichannel subscription item is renewed \* \`omnichannel_subscription_item_downgrade_scheduled\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item is downgrade is scheduled \* \`omnichannel_subscription_item_scheduled_downgrade_removed\` - \*\*(Deprecated)\*\* Triggered when an omnichannel subscription item scheduled downgrade is removed \* \`omnichannel_subscription_item_downgraded\` - Triggered when an omnichannel subscription item is downgraded \* \`omnichannel_subscription_item_expired\` - Triggered when an omnichannel subscription item is expired \* \`omnichannel_subscription_item_cancellation_scheduled\` - Triggered when an omnichannel subscription item is scheduled for cancellation \* \`omnichannel_subscription_item_scheduled_cancellation_removed\` - Triggered when an omnichannel subscription item scheduled cancellation is removed \* \`omnichannel_subscription_item_resubscribed\` - Triggered when an omnichannel subscription item is resubscribed \* \`omnichannel_subscription_item_upgraded\` - Triggered when an omnichannel subscription item is upgraded \* \`omnichannel_subscription_item_cancelled\` - Triggered when an omnichannel subscription item is cancelled \* \`omnichannel_subscription_imported\` - Triggered when an omnichannel subscription item is imported \* \`omnichannel_subscription_item_grace_period_started\` - Triggered when an omnichannel subscription item's grace period has started \* \`omnichannel_subscription_item_grace_period_expired\` - Triggered when an omnichannel subscription item's grace period has expired \* \`omnichannel_subscription_item_dunning_started\` - Triggered when an omnichannel subscription item's dunning has started \* \`omnichannel_subscription_item_dunning_expired\` - Triggered when an omnichannel subscription item's dunning has expired \* \`rule_created\` - Triggered when a rule is created \* \`rule_updated\` - Triggered when a rule is updated \* \`rule_deleted\` - Triggered when a rule is deleted \* \`record_purchase_failed\` - Triggered when an omnichannel record purchase is failed \* \`omnichannel_subscription_item_change_scheduled\` - Triggered when an omnichannel subscription item change is scheduled \* \`omnichannel_subscription_item_scheduled_change_removed\` - Triggered when an omnichannel subscription item scheduled change is removed \* \`omnichannel_subscription_item_reactivated\` - Triggered when an omnichannel subscription item's refund is reversed \* \`sales_order_created\` - Triggered when sales order is created \* \`sales_order_updated\` - Triggered when sales order is updated \* \`omnichannel_subscription_item_changed\` - Triggered when an omnichannel subscription item is changed \* \`omnichannel_subscription_item_paused\` - Triggered when an omnichannel subscription item is paused \* \`omnichannel_subscription_item_resumed\` - Triggered when an omnichannel subscription item is resumed \* \`omnichannel_one_time_order_created\` - Triggered when an omnichannel one time order is created \* \`omnichannel_one_time_order_item_cancelled\` - Triggered when an omnichannel one time order item is cancelled \* \`usage_file_ingested\` - Triggered when a usage file is ingested \* \`omnichannel_subscription_item_pause_scheduled\` - Triggered when an omnichannel subscription item scheduled for pause
              enum:
              - plan_created
              - plan_updated
              - plan_deleted
              - addon_created
              - addon_updated
              - addon_deleted
              - coupon_created
              - coupon_updated
              - coupon_deleted
              - coupon_set_created
              - coupon_set_updated
              - coupon_set_deleted
              - coupon_codes_added
              - coupon_codes_deleted
              - coupon_codes_updated
              - customer_created
              - customer_changed
              - customer_deleted
              - customer_moved_out
              - customer_moved_in
              - promotional_credits_added
              - promotional_credits_deducted
              - subscription_created
              - subscription_created_with_backdating
              - subscription_started
              - subscription_trial_end_reminder
              - subscription_activated
              - subscription_activated_with_backdating
              - subscription_changed
              - subscription_trial_extended
              - mrr_updated
              - subscription_changed_with_backdating
              - subscription_cancellation_scheduled
              - subscription_cancellation_reminder
              - subscription_cancelled
              - subscription_canceled_with_backdating
              - subscription_reactivated
              - subscription_reactivated_with_backdating
              - subscription_renewed
              - subscription_items_renewed
              - subscription_scheduled_cancellation_removed
              - subscription_changes_scheduled
              - subscription_scheduled_changes_removed
              - subscription_shipping_address_updated
              - subscription_deleted
              - subscription_paused
              - subscription_pause_scheduled
              - subscription_scheduled_pause_removed
              - subscription_resumed
              - subscription_resumption_scheduled
              - subscription_scheduled_resumption_removed
              - subscription_advance_invoice_schedule_added
              - subscription_advance_invoice_schedule_updated
              - subscription_advance_invoice_schedule_removed
              - pending_invoice_created
              - pending_invoice_updated
              - invoice_generated
              - invoice_generated_with_backdating
              - invoice_updated
              - invoice_deleted
              - credit_note_created
              - credit_note_created_with_backdating
              - credit_note_updated
              - credit_note_deleted
              - subscription_renewal_reminder
              - transaction_created
              - transaction_updated
              - transaction_deleted
              - payment_succeeded
              - payment_failed
              - dunning_updated
              - payment_refunded
              - payment_initiated
              - refund_initiated
              - authorization_succeeded
              - authorization_voided
              - card_added
              - card_updated
              - card_expiry_reminder
              - card_expired
              - card_deleted
              - payment_source_added
              - payment_source_updated
              - payment_source_deleted
              - payment_source_expiring
              - payment_source_expired
              - payment_source_locally_deleted
              - virtual_bank_account_added
              - virtual_bank_account_updated
              - virtual_bank_account_deleted
              - token_created
              - token_consumed
              - token_expired
              - unbilled_charges_created
              - unbilled_charges_voided
              - unbilled_charges_deleted
              - unbilled_charges_invoiced
              - order_created
              - order_updated
              - order_cancelled
              - order_delivered
              - order_returned
              - order_ready_to_process
              - order_ready_to_ship
              - order_deleted
              - order_resent
              - quote_created
              - quote_updated
              - quote_deleted
              - tax_withheld_recorded
              - tax_withheld_deleted
              - tax_withheld_refunded
              - gift_scheduled
              - gift_unclaimed
              - gift_claimed
              - gift_expired
              - gift_cancelled
              - gift_updated
              - hierarchy_created
              - hierarchy_deleted
              - payment_intent_created
              - payment_intent_updated
              - contract_term_created
              - contract_term_renewed
              - contract_term_terminated
              - contract_term_completed
              - contract_term_cancelled
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - subscription_moved_in
              - subscription_moved_out
              - subscription_movement_failed
              - omnichannel_subscription_created
              - omnichannel_subscription_item_renewed
              - omnichannel_subscription_item_downgraded
              - omnichannel_subscription_item_expired
              - omnichannel_subscription_item_cancellation_scheduled
              - omnichannel_subscription_item_scheduled_cancellation_removed
              - omnichannel_subscription_item_resubscribed
              - omnichannel_subscription_item_upgraded
              - omnichannel_subscription_item_cancelled
              - omnichannel_subscription_imported
              - omnichannel_subscription_item_grace_period_started
              - omnichannel_subscription_item_grace_period_expired
              - omnichannel_subscription_item_dunning_started
              - omnichannel_subscription_item_dunning_expired
              - rule_created
              - rule_updated
              - rule_deleted
              - record_purchase_failed
              - omnichannel_subscription_item_change_scheduled
              - omnichannel_subscription_item_scheduled_change_removed
              - omnichannel_subscription_item_reactivated
              - sales_order_created
              - sales_order_updated
              - omnichannel_subscription_item_changed
              - omnichannel_subscription_item_paused
              - omnichannel_subscription_item_resumed
              - omnichannel_one_time_order_created
              - omnichannel_one_time_order_item_cancelled
              - usage_file_ingested
              - omnichannel_subscription_item_pause_scheduled
              pattern: "^\\[(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|usage_file_ingested|omnichannel_subscription_item_pause_scheduled)(,(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|usage_file_ingested|omnichannel_subscription_item_pause_scheduled))*\\\
                ]$"
              example: null
      - name: source
        in: query
        description: |
          optional, enumerated string filter

          Source of the event. Possible values are : admin_console, api, scheduled_job, hosted_page, portal, system, none, js_api, migration, bulk_operation, external_service.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *source\[is\] = "hosted_page"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: hosted_page
          properties:
            is:
              type: string
              description: |
                \* \`admin_console\` - Operation made through the Chargebee admin UI \* \`api\` - Operation made through the API \* \`scheduled_job\` - Operation made through the Scheduled Jobs \* \`hosted_page\` - Operation made through the Hosted Pages \* \`portal\` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html) \* \`system\` - Operation that are triggered by ChargeBee System \* \`none\` - If no source can be identified for an operation \* \`js_api\` - Operation made through the JS API \* \`migration\` - Operation that was triggered triggered by the migration of customer data into Chargebee Billing, either from an external system or from another [Chargebee Billing site](https://www.chargebee.com/docs/billing/2.0/getting-started/sites-intro.html) (such as test, live, or sandbox). \* \`bulk_operation\` - Operation that are triggerd through bulk operation. \* \`external_service\` - Operation that are triggered via webhook
              enum:
              - admin_console
              - api
              - scheduled_job
              - hosted_page
              - portal
              - system
              - none
              - js_api
              - migration
              - bulk_operation
              - external_service
              example: null
            is_not:
              type: string
              description: |
                \* \`admin_console\` - Operation made through the Chargebee admin UI \* \`api\` - Operation made through the API \* \`scheduled_job\` - Operation made through the Scheduled Jobs \* \`hosted_page\` - Operation made through the Hosted Pages \* \`portal\` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html) \* \`system\` - Operation that are triggered by ChargeBee System \* \`none\` - If no source can be identified for an operation \* \`js_api\` - Operation made through the JS API \* \`migration\` - Operation that was triggered triggered by the migration of customer data into Chargebee Billing, either from an external system or from another [Chargebee Billing site](https://www.chargebee.com/docs/billing/2.0/getting-started/sites-intro.html) (such as test, live, or sandbox). \* \`bulk_operation\` - Operation that are triggerd through bulk operation. \* \`external_service\` - Operation that are triggered via webhook
              enum:
              - admin_console
              - api
              - scheduled_job
              - hosted_page
              - portal
              - system
              - none
              - js_api
              - migration
              - bulk_operation
              - external_service
              example: null
            in:
              type: string
              description: |
                \* \`admin_console\` - Operation made through the Chargebee admin UI \* \`api\` - Operation made through the API \* \`scheduled_job\` - Operation made through the Scheduled Jobs \* \`hosted_page\` - Operation made through the Hosted Pages \* \`portal\` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html) \* \`system\` - Operation that are triggered by ChargeBee System \* \`none\` - If no source can be identified for an operation \* \`js_api\` - Operation made through the JS API \* \`migration\` - Operation that was triggered triggered by the migration of customer data into Chargebee Billing, either from an external system or from another [Chargebee Billing site](https://www.chargebee.com/docs/billing/2.0/getting-started/sites-intro.html) (such as test, live, or sandbox). \* \`bulk_operation\` - Operation that are triggerd through bulk operation. \* \`external_service\` - Operation that are triggered via webhook
              enum:
              - admin_console
              - api
              - scheduled_job
              - hosted_page
              - portal
              - system
              - none
              - js_api
              - migration
              - bulk_operation
              - external_service
              pattern: "^\\[(admin_console|api|scheduled_job|hosted_page|portal|system|none|js_api|migration|bulk_operation|external_service)(,(admin_console|api|scheduled_job|hosted_page|portal|system|none|js_api|migration|bulk_operation|external_service))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`admin_console\` - Operation made through the Chargebee admin UI \* \`api\` - Operation made through the API \* \`scheduled_job\` - Operation made through the Scheduled Jobs \* \`hosted_page\` - Operation made through the Hosted Pages \* \`portal\` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html) \* \`system\` - Operation that are triggered by ChargeBee System \* \`none\` - If no source can be identified for an operation \* \`js_api\` - Operation made through the JS API \* \`migration\` - Operation that was triggered triggered by the migration of customer data into Chargebee Billing, either from an external system or from another [Chargebee Billing site](https://www.chargebee.com/docs/billing/2.0/getting-started/sites-intro.html) (such as test, live, or sandbox). \* \`bulk_operation\` - Operation that are triggerd through bulk operation. \* \`external_service\` - Operation that are triggered via webhook
              enum:
              - admin_console
              - api
              - scheduled_job
              - hosted_page
              - portal
              - system
              - none
              - js_api
              - migration
              - bulk_operation
              - external_service
              pattern: "^\\[(admin_console|api|scheduled_job|hosted_page|portal|system|none|js_api|migration|bulk_operation|external_service)(,(admin_console|api|scheduled_job|hosted_page|portal|system|none|js_api|migration|bulk_operation|external_service))*\\\
                ]$"
              example: null
      - name: occurred_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp indicating when this event had occurred.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *occurred_at\[before\] = "1349116200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1349116200"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          occurred_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "occurred_at"*

          This will sort the result based on the 'occurred_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - occurred_at
              example: null
            desc:
              type: string
              enum:
              - occurred_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        event:
                          $ref: "#/components/schemas/Event"
                          description: Resource object representing event
                      required:
                      - event
                      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: []
  /events/{event-id}:
    get:
      summary: Retrieve an event
      description: "Retrieves a specific event identified by a unique event identifier.\
        \  \n**Note:**\nOnly events that are less than 90 days old will be retrieved.\n"
      operationId: retrieve_an_event
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: event-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/event-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  event:
                    $ref: "#/components/schemas/Event"
                    description: <p class="mb-2">Resource object representing event</p>
                required:
                - event
                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: []
  /comments/{comment-id}/delete:
    post:
      summary: Delete a comment
      description: |
        Delete a comment for an [entity](/docs/api/v2/pcv-1/comments/create-a-comment#entity_type) identified by comment ID.

        Only the comments that are added via Admin console and API can be deleted. Chargebee generated "System" comments cannot be deleted.
      operationId: delete_a_comment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: comment-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/comment-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  comment:
                    $ref: "#/components/schemas/Comment"
                    description: <p class="mb-2">Resource object representing comment</p>
                required:
                - comment
                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: []
  /comments/{comment-id}:
    get:
      summary: Retrieve a comment
      description: |
        Retrieve a comment for an entity identified by comment ID.
      operationId: retrieve_a_comment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: comment-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/comment-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  comment:
                    $ref: "#/components/schemas/Comment"
                    description: <p class="mb-2">Resource object representing comment</p>
                required:
                - comment
                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: []
  /comments:
    get:
      summary: List comments
      description: |
        Retrieve the list of comments sorted by the recent ones on the top.

        If you want to retrieve the list of comments for an [entity](/docs/api/v2/pcv-1/comments/list-comments), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
      operationId: list_comments
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: entity_type
        in: query
        description: |
          Type of the entity this comment generated for.
          \* item -

          Entity that represents item
          \* order -

          Entity that represents an order
          \* item_price -

          Entity that represents item price
          \* customer -

          Entity that represents a customer
          \* variant -

          Entity that represents product variants
          \* invoice -

          Invoice description
          \* product -

          Entity that represents product
          \* business_entity -

          Entity that represents item of type business entity
          \* plan -

          Entity that represents a subscription plan
          \* coupon -

          Entity that represents a discount coupon
          \* subscription -

          Entity that represents a subscription of a customer
          \* item_family -

          Entity that represents item family
          \* transaction -

          Entity that represents a transaction.
          \* addon -

          Entity that represents an addon
          \* credit_note -

          Credit note description
          \* quote -

          Entity that represents a quote
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - customer
          - subscription
          - invoice
          - quote
          - credit_note
          - transaction
          - plan
          - addon
          - coupon
          - order
          - business_entity
          example: null
      - name: entity_id
        in: query
        description: |
          Unique identifier of the entity.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The time at which this comment was created.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[after\] = "1456332678"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1456332678"
          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
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          created_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "created_at"*

          This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - created_at
              example: null
            desc:
              type: string
              enum:
              - created_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        comment:
                          $ref: "#/components/schemas/Comment"
                          description: Resource object representing comment
                      required:
                      - comment
                      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: []
    post:
      summary: Create a comment
      description: |
        Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
      operationId: create_a_comment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                entity_type:
                  type: string
                  deprecated: false
                  description: |
                    Type of the entity to create the comment for.
                    \* item -

                    Entity that represents item
                    \* order -

                    Entity that represents an order
                    \* item_price -

                    Entity that represents item price
                    \* customer -

                    Entity that represents a customer
                    \* variant -

                    Entity that represents product variants
                    \* invoice -

                    Invoice description
                    \* product -

                    Entity that represents product
                    \* business_entity -

                    Entity that represents item of type business entity
                    \* plan -

                    Entity that represents a subscription plan
                    \* coupon -

                    Entity that represents a discount coupon
                    \* subscription -

                    Entity that represents a subscription of a customer
                    \* item_family -

                    Entity that represents item family
                    \* transaction -

                    Entity that represents a transaction.
                    \* addon -

                    Entity that represents an addon
                    \* credit_note -

                    Credit note description
                    \* quote -

                    Entity that represents a quote
                  enum:
                  - customer
                  - subscription
                  - invoice
                  - quote
                  - credit_note
                  - transaction
                  - plan
                  - addon
                  - coupon
                  - order
                  - business_entity
                  example: null
                entity_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique identifier of the entity.
                  maxLength: 100
                  example: null
                notes:
                  type: string
                  deprecated: false
                  description: |
                    Actual notes for the comment.
                  maxLength: 1000
                  example: null
                added_by:
                  type: string
                  deprecated: false
                  description: |
                    The user who created the comment. If created via API, this contains the name given for the API key used.
                  maxLength: 100
                  example: null
              required:
              - entity_id
              - entity_type
              - notes
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  comment:
                    $ref: "#/components/schemas/Comment"
                    description: <p class="mb-2">Resource object representing comment</p>
                required:
                - comment
                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: []
  /portal_sessions:
    post:
      summary: Create a portal session
      description: |
        Creates a portal session for a customer. The session resource in the response contains the access URL. Forward the customer to that access URL. If you would like to logout the customer later via API call, you need to store the id of the portal session resource returned by this API. While creating a session, you also need to pass the redirect URL to which your customers will be sent to upon logout from the portal UI.
      operationId: create_a_portal_session
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    URL to redirect when the user logs out from the portal.
                  maxLength: 250
                  example: null
                forward_url:
                  type: string
                  deprecated: false
                  description: |
                    By default access_url redirects the customer to the portal home page. If you would like to redirect the customer to a different URL, you can use this parameter to do so.

                    **Note:**
                    This parameter is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html)
                    portal.
                  maxLength: 250
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  portal_session:
                    $ref: "#/components/schemas/PortalSession"
                    description: <p class="mb-2">Resource object representing portal_session</p>
                required:
                - portal_session
                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: []
  /portal_sessions/{portal-session-id}/activate:
    post:
      summary: Activate a portal session
      description: |
        When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:

        * **auth_session_id** - this should be sent as part of the endpoint.
        * **auth_session_token** - this should be sent as value for the input parameter **token**.

        **Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
      operationId: activate_a_portal_session
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: portal-session-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/portal-session-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                token:
                  type: string
                  deprecated: false
                  description: |
                    Unique pre-authenticated portal session token to access customer portal directly.
                  maxLength: 70
                  example: null
              required:
              - token
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  portal_session:
                    $ref: "#/components/schemas/PortalSession"
                    description: <p class="mb-2">Resource object representing portal_session</p>
                required:
                - portal_session
                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: []
  /portal_sessions/{portal-session-id}/logout:
    post:
      summary: Logout a portal session
      description: |
        Logs out the portal session. Typically this should be called when customers logout of your application.

        If this API is called for a Portal Session that currently is in :

        * "created" status, the session status will be marked as "logged_out" and the access URL will become invalid.
        * "logged_in" status, the session status will be marked as "logged_out" and customer will not be able to use that session.
        * "logged_out" status, this will return normally without changing any attribute of this resource.
      operationId: logout_a_portal_session
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: portal-session-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/portal-session-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  portal_session:
                    $ref: "#/components/schemas/PortalSession"
                    description: <p class="mb-2">Resource object representing portal_session</p>
                required:
                - portal_session
                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: []
  /portal_sessions/{portal-session-id}:
    get:
      summary: Retrieve a portal session
      description: |-
        <div class="api-description"><p class="mb-2">This API retrieves a portal session using <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">portal_session_id</code>
        as a path parameter.</p></div>
      operationId: retrieve_a_portal_session
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: portal-session-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/portal-session-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  portal_session:
                    $ref: "#/components/schemas/PortalSession"
                    description: <p class="mb-2">Resource object representing portal_session</p>
                required:
                - portal_session
                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: []
  /site_migration_details:
    get:
      summary: List site migration details
      description: |
        This endpoint lists the site migration details.
      operationId: list_site_migration_details
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: entity_id_at_other_site
        in: query
        description: |
          optional, string filter

          Entity Id of the record in the other site.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *entity_id_at_other_site\[is\] = "null"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
          example: null
      - name: other_site_name
        in: query
        description: |
          optional, string filter

          Site name to which the record is moved in/out.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *other_site_name\[is_not\] = "acme-test"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: acme-test
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: entity_id
        in: query
        description: |
          optional, string filter

          Id of the entity in this site.
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *entity_id\[is\] = "8axqwer7as"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8axqwer7as
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
      - name: entity_type
        in: query
        description: |
          optional, enumerated string filter

          Entity Type of the record. Possible values are : customer, subscription, invoice, credit_note, transaction, order.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *entity_type\[is\] = "customer"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: customer
          properties:
            is:
              type: string
              description: |
                \* \`customer\` - Entity that represents a customer \* \`subscription\` - Entity that represents a subscription of a customer \* \`invoice\` - Invoice description \* \`credit_note\` - Credit note description \* \`transaction\` - Entity that represents a transaction. \* \`order\` - Entity that represents an order
              enum:
              - customer
              - subscription
              - invoice
              - credit_note
              - transaction
              - order
              example: null
            is_not:
              type: string
              description: |
                \* \`customer\` - Entity that represents a customer \* \`subscription\` - Entity that represents a subscription of a customer \* \`invoice\` - Invoice description \* \`credit_note\` - Credit note description \* \`transaction\` - Entity that represents a transaction. \* \`order\` - Entity that represents an order
              enum:
              - customer
              - subscription
              - invoice
              - credit_note
              - transaction
              - order
              example: null
            in:
              type: string
              description: |
                \* \`customer\` - Entity that represents a customer \* \`subscription\` - Entity that represents a subscription of a customer \* \`invoice\` - Invoice description \* \`credit_note\` - Credit note description \* \`transaction\` - Entity that represents a transaction. \* \`order\` - Entity that represents an order
              enum:
              - customer
              - subscription
              - invoice
              - credit_note
              - transaction
              - order
              pattern: "^\\[(customer|subscription|invoice|credit_note|transaction|order)(,(customer|subscription|invoice|credit_note|transaction|order))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`customer\` - Entity that represents a customer \* \`subscription\` - Entity that represents a subscription of a customer \* \`invoice\` - Invoice description \* \`credit_note\` - Credit note description \* \`transaction\` - Entity that represents a transaction. \* \`order\` - Entity that represents an order
              enum:
              - customer
              - subscription
              - invoice
              - credit_note
              - transaction
              - order
              pattern: "^\\[(customer|subscription|invoice|credit_note|transaction|order)(,(customer|subscription|invoice|credit_note|transaction|order))*\\\
                ]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Status of the migration. Possible values are : moved_in, moved_out, moving_out.

          **Supported operators :**
          is, is_not, in, not_in

          **Example →**
          *status\[is\] = "MOVED_OUT"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: MOVED_OUT
          properties:
            is:
              type: string
              description: |
                \* \`moved_in\` - Moved in from another cb site \* \`moved_out\` - Moved out from one cb site to another \* \`moving_out\` - Moving out from one cb site to another
              enum:
              - moved_in
              - moved_out
              - moving_out
              example: null
            is_not:
              type: string
              description: |
                \* \`moved_in\` - Moved in from another cb site \* \`moved_out\` - Moved out from one cb site to another \* \`moving_out\` - Moving out from one cb site to another
              enum:
              - moved_in
              - moved_out
              - moving_out
              example: null
            in:
              type: string
              description: |
                \* \`moved_in\` - Moved in from another cb site \* \`moved_out\` - Moved out from one cb site to another \* \`moving_out\` - Moving out from one cb site to another
              enum:
              - moved_in
              - moved_out
              - moving_out
              pattern: "^\\[(moved_in|moved_out|moving_out)(,(moved_in|moved_out|moving_out))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`moved_in\` - Moved in from another cb site \* \`moved_out\` - Moved out from one cb site to another \* \`moving_out\` - Moving out from one cb site to another
              enum:
              - moved_in
              - moved_out
              - moving_out
              pattern: "^\\[(moved_in|moved_out|moving_out)(,(moved_in|moved_out|moving_out))*\\\
                ]$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        site_migration_detail:
                          $ref: "#/components/schemas/SiteMigrationDetail"
                          description: Resource object representing site_migration_detail
                      required:
                      - site_migration_detail
                      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: []
  /resource_migrations/retrieve_latest:
    get:
      summary: Retrieve latest migration details
      description: |
        Gets the last migration details.
      operationId: retrieve_latest_migration_details
      parameters:
      - name: from_site
        in: query
        description: |
          Domain name to which the item is moved.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          minLength: 4
          example: null
      - name: entity_type
        in: query
        description: |
          Type of the entity this record is stored for.
          \* customer -

          Entity that represents a customer
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - customer
          example: null
      - name: entity_id
        in: query
        description: |
          Handle of the customer in the current site.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  resource_migration:
                    $ref: "#/components/schemas/ResourceMigration"
                    description: <p class="mb-2">Resource object representing resource_migration</p>
                required:
                - resource_migration
                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: []
  /time_machines/{time-machine-name}:
    get:
      summary: Retrieve a time machine
      description: |
        Retrieves the time machine. Currently only one time machine is available per site and is named 'delorean'.
      operationId: retrieve_a_time_machine
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: time-machine-name
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/time-machine-name"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  time_machine:
                    $ref: "#/components/schemas/TimeMachine"
                    description: <p class="mb-2">Resource object representing time_machine</p>
                required:
                - time_machine
                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: []
  /time_machines/{time-machine-name}/travel_forward:
    post:
      summary: Travel forward
      description: |
        Travel forward in time. This operation is **asynchronous**
        .
        You need to check if the "start afresh" operation has completed by checking if the time travel status is **successful**
        by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests.
        Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes.
      operationId: travel_forward
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: time-machine-name
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/time-machine-name"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                destination_time:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The **time**
                    to travel to. Should be between the 'current' destination time of the time machine and present time.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  time_machine:
                    $ref: "#/components/schemas/TimeMachine"
                    description: <p class="mb-2">Resource object representing time_machine</p>
                required:
                - time_machine
                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: []
  /time_machines/{time-machine-name}/start_afresh:
    post:
      summary: Start Afresh
      description: |
        Restart the time machine. This will clear the "customer" data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.

        **Note:**
        This API call is asynchronous.
        You need to check if the "start afresh" operation has completed by checking if the time travel status is **successful**
        by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for time travel completion**
        function provided as a instance method in the library.
        Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **WaitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes.
      operationId: start_afresh
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: time-machine-name
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/time-machine-name"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                genesis_time:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.

                    **Note:**
                    Can only be in the past.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  time_machine:
                    $ref: "#/components/schemas/TimeMachine"
                    description: <p class="mb-2">Resource object representing time_machine</p>
                required:
                - time_machine
                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: []
  /exports/customers:
    post:
      summary: Export Customers
      description: |
        This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
      operationId: export_customers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                export_type:
                  type: string
                  default: data
                  deprecated: false
                  description: |
                    Determines the format of the data. Returns the export type based on the selected value.
                    \* data -

                    Download your current data in CSV.
                    \* import_friendly_data -

                    Download import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html)
                    .
                  enum:
                  - data
                  - import_friendly_data
                  example: null
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \*\*Note\*\* \[Multiple Business Entities\](/docs/api/getting-started) is a feature available only on Product Catalog 2.0. \*\*Supported operators :\*\* is, is_not, starts_with \*\*Example →\*\* \*business_entity_id\\\[is\\\] = "business_entity_id"\*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_not:
                      type: string
                      minLength: 1
                      example: null
                    starts_with:
                      type: string
                      minLength: 1
                      example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      example: 9bsvnHgsvmsI
                      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
                    first_name:
                      type: object
                      deprecated: false
                      description: |
                        First name of the customer
                      example: John
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    last_name:
                      type: object
                      deprecated: false
                      description: |
                        Last name of the customer
                      example: Clint
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    email:
                      type: object
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      example: john@test.com
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    company:
                      type: object
                      deprecated: false
                      description: |
                        Company name of the customer.
                      example: Globex Corp
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    phone:
                      type: object
                      deprecated: false
                      description: |
                        Phone number of the customer
                      example: (541) 754-3010
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    auto_collection:
                      type: object
                      deprecated: false
                      description: |
                        Whether payments needs to be collected automatically for this customer
                      example: "on"
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                    taxability:
                      type: object
                      deprecated: false
                      description: |
                        Specifies if the customer is liable for tax
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating when this customer resource is created.
                      example: "1435054328"
                      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
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the customer.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |
                        Override for this customer, the \[site-level setting\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \[subscription level\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                relationship:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for relationship
                  properties:
                    parent_id:
                      type: object
                      deprecated: false
                      description: |
                        Immediate parent with whom we will link our new customer(child)
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    payment_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to pay
                      example: active1
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    invoice_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to handle invoices
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                  example: null
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              relationship:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/transactions:
    post:
      summary: Export Transactions
      description: |
        This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
      operationId: export_transactions
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                transaction:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for transaction
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Uniquely identifies the transaction.
                      example: txn_88ybdbsnvf2
                      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
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer for which this transaction is made
                      example: 5hjdk8nOpd
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    subscription_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the subscription for which this transaction is made.
                      example: 5hjdk8nOpd
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    payment_source_id:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on Transaction payment source id.
                      example: pm_3Nl8XXUQUXDVFa2
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The payment method of this transaction
                      example: card
                      properties:
                        is:
                          type: string
                          description: |-
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                            * `ach_credit` - ACH Credit
                            * `sepa_credit` - SEPA Credit
                            * `ideal` - IDEAL
                            * `google_pay` - Google Pay
                            * `sofort` - Sofort
                            * `bancontact` - Bancontact
                            * `giropay` - giropay
                            * `dotpay` - Dotpay
                            * `other` - Payment Methods other than the above types
                            * `app_store` - **(Deprecated)** App Store
                            * `upi` - upi
                            * `netbanking_emandates` - netbanking_emandates
                            * `play_store` - **(Deprecated)** Play Store
                            * `custom` - Custom
                            * `boleto` - boleto
                            * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                            * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                            * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                            * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                            * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                            * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                            * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                            * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                            * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                            * `kbc_payment_button` - Payments made via KBC Payment Button.
                            * `pay_by_bank` - Payments made via Pay By Bank.
                            * `trustly` - Payments made via Trustly.
                            * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                            * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                            * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                            * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                            * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                            * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                            * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                            * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                            * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                            * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                            * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                            * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                            * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                            * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
                          enum:
                          - card
                          - cash
                          - check
                          - chargeback
                          - bank_transfer
                          - amazon_payments
                          - paypal_express_checkout
                          - direct_debit
                          - alipay
                          - unionpay
                          - apple_pay
                          - wechat_pay
                          - ach_credit
                          - sepa_credit
                          - ideal
                          - google_pay
                          - sofort
                          - bancontact
                          - giropay
                          - dotpay
                          - other
                          - upi
                          - netbanking_emandates
                          - custom
                          - boleto
                          - venmo
                          - pay_to
                          - faster_payments
                          - sepa_instant_transfer
                          - automated_bank_transfer
                          - klarna_pay_now
                          - online_banking_poland
                          - payconiq_by_bancontact
                          - electronic_payment_standard
                          - kbc_payment_button
                          - pay_by_bank
                          - trustly
                          - stablecoin
                          - kakao_pay
                          - naver_pay
                          - revolut_pay
                          - cash_app_pay
                          - pix
                          - twint
                          - go_pay
                          - grab_pay
                          - pay_co
                          - after_pay
                          - swish
                          - payme
                          - klarna
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                            * `ach_credit` - ACH Credit
                            * `sepa_credit` - SEPA Credit
                            * `ideal` - IDEAL
                            * `google_pay` - Google Pay
                            * `sofort` - Sofort
                            * `bancontact` - Bancontact
                            * `giropay` - giropay
                            * `dotpay` - Dotpay
                            * `other` - Payment Methods other than the above types
                            * `app_store` - **(Deprecated)** App Store
                            * `upi` - upi
                            * `netbanking_emandates` - netbanking_emandates
                            * `play_store` - **(Deprecated)** Play Store
                            * `custom` - Custom
                            * `boleto` - boleto
                            * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                            * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                            * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                            * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                            * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                            * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                            * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                            * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                            * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                            * `kbc_payment_button` - Payments made via KBC Payment Button.
                            * `pay_by_bank` - Payments made via Pay By Bank.
                            * `trustly` - Payments made via Trustly.
                            * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                            * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                            * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                            * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                            * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                            * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                            * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                            * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                            * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                            * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                            * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                            * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                            * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                            * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
                          enum:
                          - card
                          - cash
                          - check
                          - chargeback
                          - bank_transfer
                          - amazon_payments
                          - paypal_express_checkout
                          - direct_debit
                          - alipay
                          - unionpay
                          - apple_pay
                          - wechat_pay
                          - ach_credit
                          - sepa_credit
                          - ideal
                          - google_pay
                          - sofort
                          - bancontact
                          - giropay
                          - dotpay
                          - other
                          - upi
                          - netbanking_emandates
                          - custom
                          - boleto
                          - venmo
                          - pay_to
                          - faster_payments
                          - sepa_instant_transfer
                          - automated_bank_transfer
                          - klarna_pay_now
                          - online_banking_poland
                          - payconiq_by_bancontact
                          - electronic_payment_standard
                          - kbc_payment_button
                          - pay_by_bank
                          - trustly
                          - stablecoin
                          - kakao_pay
                          - naver_pay
                          - revolut_pay
                          - cash_app_pay
                          - pix
                          - twint
                          - go_pay
                          - grab_pay
                          - pay_co
                          - after_pay
                          - swish
                          - payme
                          - klarna
                          example: null
                        in:
                          type: string
                          description: |-
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                            * `ach_credit` - ACH Credit
                            * `sepa_credit` - SEPA Credit
                            * `ideal` - IDEAL
                            * `google_pay` - Google Pay
                            * `sofort` - Sofort
                            * `bancontact` - Bancontact
                            * `giropay` - giropay
                            * `dotpay` - Dotpay
                            * `other` - Payment Methods other than the above types
                            * `app_store` - **(Deprecated)** App Store
                            * `upi` - upi
                            * `netbanking_emandates` - netbanking_emandates
                            * `play_store` - **(Deprecated)** Play Store
                            * `custom` - Custom
                            * `boleto` - boleto
                            * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                            * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                            * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                            * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                            * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                            * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                            * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                            * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                            * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                            * `kbc_payment_button` - Payments made via KBC Payment Button.
                            * `pay_by_bank` - Payments made via Pay By Bank.
                            * `trustly` - Payments made via Trustly.
                            * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                            * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                            * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                            * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                            * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                            * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                            * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                            * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                            * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                            * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                            * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                            * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                            * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                            * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
                          enum:
                          - card
                          - cash
                          - check
                          - chargeback
                          - bank_transfer
                          - amazon_payments
                          - paypal_express_checkout
                          - direct_debit
                          - alipay
                          - unionpay
                          - apple_pay
                          - wechat_pay
                          - ach_credit
                          - sepa_credit
                          - ideal
                          - google_pay
                          - sofort
                          - bancontact
                          - giropay
                          - dotpay
                          - other
                          - upi
                          - netbanking_emandates
                          - custom
                          - boleto
                          - venmo
                          - pay_to
                          - faster_payments
                          - sepa_instant_transfer
                          - automated_bank_transfer
                          - klarna_pay_now
                          - online_banking_poland
                          - payconiq_by_bancontact
                          - electronic_payment_standard
                          - kbc_payment_button
                          - pay_by_bank
                          - trustly
                          - stablecoin
                          - kakao_pay
                          - naver_pay
                          - revolut_pay
                          - cash_app_pay
                          - pix
                          - twint
                          - go_pay
                          - grab_pay
                          - pay_co
                          - after_pay
                          - swish
                          - payme
                          - klarna
                          pattern: "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>.
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay <span isMicro='true' featureId='cb-alipay'></span>
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay <span isMicro='true' featureId='cb-wechat-pay'></span>
                            * `ach_credit` - ACH Credit
                            * `sepa_credit` - SEPA Credit
                            * `ideal` - IDEAL
                            * `google_pay` - Google Pay
                            * `sofort` - Sofort
                            * `bancontact` - Bancontact
                            * `giropay` - giropay
                            * `dotpay` - Dotpay
                            * `other` - Payment Methods other than the above types
                            * `app_store` - **(Deprecated)** App Store
                            * `upi` - upi
                            * `netbanking_emandates` - netbanking_emandates
                            * `play_store` - **(Deprecated)** Play Store
                            * `custom` - Custom
                            * `boleto` - boleto
                            * `venmo` - Venmo <span isMicro='true' featureId='cb-venmo'></span>
                            * `pay_to` - PayTo <span isMicro='true' featureId='cb-pay-to'></span>
                            * `faster_payments` - Faster Payments <span isMicro='true' featureId='cb-faster-payments'></span>
                            * `sepa_instant_transfer` - Sepa Instant Transfer <span isMicro='true' featureId='cb-sepa-instant-transfer'></span>
                            * `automated_bank_transfer` - Automated Bank Transfer <span isMicro='true' featureId='cb-bank-transfer'></span>
                            * `klarna_pay_now` - Klarna Pay Now <span isMicro='true' featureId='cb-klarna-pay-now'></span>
                            * `online_banking_poland` - Online Banking Poland <span isMicro='true' featureId='cb-online-banking-poland'></span>
                            * `payconiq_by_bancontact` - Payconiq by Bancontact <span isMicro='true' featureId='cb-payconiq-by-bancontact'></span>
                            * `electronic_payment_standard` - Payments made via Electronic Payment Standard.
                            * `kbc_payment_button` - Payments made via KBC Payment Button.
                            * `pay_by_bank` - Payments made via Pay By Bank.
                            * `trustly` - Payments made via Trustly.
                            * `stablecoin` - Stablecoin <span isMicro='true' featureId='cb-stablecoin'></span>
                            * `kakao_pay` - Kakao Pay <span isMicro='true' featureId='cb-kakao-pay'></span>
                            * `naver_pay` - Naver Pay <span isMicro='true' featureId='cb-naver-pay'></span>
                            * `revolut_pay` - Revolut Pay <span isMicro='true' featureId='cb-revolut-pay'></span>
                            * `cash_app_pay` - Cash App Pay <span isMicro='true' featureId='cb-cash-app-pay'></span>
                            * `pix` - Payments made via Pix <span isMicro='true' featureId='cb-pix'></span>
                            * `twint` - Twint <span isMicro='true' featureId='cb-twint'></span>
                            * `go_pay` - Go Pay <span isMicro='true' featureId='cb-go-pay'></span>
                            * `grab_pay` - Grab Pay <span isMicro='true' featureId='cb-grab-pay'></span>
                            * `pay_co` - Pay Co <span isMicro='true' featureId='cb-pay-co'></span>
                            * `after_pay` - After Pay <span isMicro='true' featureId='cb-after-pay'></span>
                            * `swish` - Swish <span isMicro='true' featureId='cb-swish'></span>
                            * `payme` - PayMe <span isMicro='true' featureId='cb-payme'></span>
                            * `klarna` - Payments made via Klarna <span isMicro='true' featureId='cb-klarna'></span>
                          enum:
                          - card
                          - cash
                          - check
                          - chargeback
                          - bank_transfer
                          - amazon_payments
                          - paypal_express_checkout
                          - direct_debit
                          - alipay
                          - unionpay
                          - apple_pay
                          - wechat_pay
                          - ach_credit
                          - sepa_credit
                          - ideal
                          - google_pay
                          - sofort
                          - bancontact
                          - giropay
                          - dotpay
                          - other
                          - upi
                          - netbanking_emandates
                          - custom
                          - boleto
                          - venmo
                          - pay_to
                          - faster_payments
                          - sepa_instant_transfer
                          - automated_bank_transfer
                          - klarna_pay_now
                          - online_banking_poland
                          - payconiq_by_bancontact
                          - electronic_payment_standard
                          - kbc_payment_button
                          - pay_by_bank
                          - trustly
                          - stablecoin
                          - kakao_pay
                          - naver_pay
                          - revolut_pay
                          - cash_app_pay
                          - pix
                          - twint
                          - go_pay
                          - grab_pay
                          - pay_co
                          - after_pay
                          - swish
                          - payme
                          - klarna
                          pattern: "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\\
                            ]$"
                          example: null
                    gateway:
                      type: object
                      deprecated: false
                      description: |
                        Gateway through which this transaction was done. Applicable only for 'Card' Payment Method
                      example: stripe
                      properties:
                        is:
                          type: string
                          description: |-
                            * `chargebee` - Chargebee test gateway.
                            * `chargebee_payments` - Chargebee Payments gateway
                            * `adyen` - Adyen is a payment gateway.
                            * `stripe` - Stripe is a payment gateway.
                            * `wepay` - WePay is a payment gateway.
                            * `braintree` - Braintree is a payment gateway.
                            * `authorize_net` - Authorize.net is a payment gateway
                            * `paypal_pro` - PayPal Pro Account is a payment gateway.
                            * `pin` - Pin is a payment gateway
                            * `eway` - eWAY Account is a payment gateway.
                            * `eway_rapid` - eWAY Rapid is a payment gateway.
                            * `worldpay` - WorldPay is a payment gateway
                            * `balanced_payments` - Balanced is a payment gateway
                            * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                            * `bluepay` - BluePay is a payment gateway.
                            * `elavon` - Elavon Virtual Merchant is a payment solution.
                            * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                            * `hdfc` - HDFC Account is a payment gateway.
                            * `migs` - MasterCard Internet Gateway Service payment gateway.
                            * `nmi` - NMI is a payment gateway.
                            * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                            * `paymill` - PAYMILL is a payment gateway.
                            * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                            * `sage_pay` - Sage Pay is a payment gateway.
                            * `tco` - 2Checkout is a payment gateway.
                            * `wirecard` - WireCard Account is a payment service provider.
                            * `amazon_payments` - Amazon Payments is a payment service provider.
                            * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                            * `gocardless` - GoCardless is a payment service provider.
                            * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                            * `moneris_us` - Moneris USA is a payment gateway.
                            * `moneris` - Moneris is a payment gateway.
                            * `bluesnap` - BlueSnap is a payment gateway.
                            * `cybersource` - CyberSource is a payment gateway.
                            * `vantiv` - Vantiv is a payment gateway.
                            * `checkout_com` - Checkout.com is a payment gateway.
                            * `paypal` - PayPal Commerce is a payment gateway.
                            * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                            * `exact` - Exact Payments is a payment gateway.
                            * `mollie` - Mollie is a payment gateway.
                            * `quickbooks` - Intuit QuickBooks Payments gateway
                            * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                            * `global_payments` - Global Payments is a payment service provider.
                            * `bank_of_america` - Bank of America Gateway
                            * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                            * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                            * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                            * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                            * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                            * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                            * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                            * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                            * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                            * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                            * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                            * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                            * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                            * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                            * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                            * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                            * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
                          enum:
                          - chargebee
                          - chargebee_payments
                          - adyen
                          - stripe
                          - wepay
                          - braintree
                          - authorize_net
                          - paypal_pro
                          - pin
                          - eway
                          - eway_rapid
                          - worldpay
                          - balanced_payments
                          - beanstream
                          - bluepay
                          - elavon
                          - first_data_global
                          - hdfc
                          - migs
                          - nmi
                          - ogone
                          - paymill
                          - paypal_payflow_pro
                          - sage_pay
                          - tco
                          - wirecard
                          - amazon_payments
                          - paypal_express_checkout
                          - gocardless
                          - orbital
                          - moneris_us
                          - moneris
                          - bluesnap
                          - cybersource
                          - vantiv
                          - checkout_com
                          - paypal
                          - ingenico_direct
                          - exact
                          - mollie
                          - quickbooks
                          - razorpay
                          - global_payments
                          - bank_of_america
                          - ecentric
                          - metrics_global
                          - windcave
                          - pay_com
                          - ebanx
                          - dlocal
                          - nuvei
                          - solidgate
                          - paystack
                          - jp_morgan
                          - deutsche_bank
                          - ezidebit
                          - twikey
                          - tempus
                          - moyasar
                          - payway
                          - not_applicable
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `chargebee` - Chargebee test gateway.
                            * `chargebee_payments` - Chargebee Payments gateway
                            * `adyen` - Adyen is a payment gateway.
                            * `stripe` - Stripe is a payment gateway.
                            * `wepay` - WePay is a payment gateway.
                            * `braintree` - Braintree is a payment gateway.
                            * `authorize_net` - Authorize.net is a payment gateway
                            * `paypal_pro` - PayPal Pro Account is a payment gateway.
                            * `pin` - Pin is a payment gateway
                            * `eway` - eWAY Account is a payment gateway.
                            * `eway_rapid` - eWAY Rapid is a payment gateway.
                            * `worldpay` - WorldPay is a payment gateway
                            * `balanced_payments` - Balanced is a payment gateway
                            * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                            * `bluepay` - BluePay is a payment gateway.
                            * `elavon` - Elavon Virtual Merchant is a payment solution.
                            * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                            * `hdfc` - HDFC Account is a payment gateway.
                            * `migs` - MasterCard Internet Gateway Service payment gateway.
                            * `nmi` - NMI is a payment gateway.
                            * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                            * `paymill` - PAYMILL is a payment gateway.
                            * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                            * `sage_pay` - Sage Pay is a payment gateway.
                            * `tco` - 2Checkout is a payment gateway.
                            * `wirecard` - WireCard Account is a payment service provider.
                            * `amazon_payments` - Amazon Payments is a payment service provider.
                            * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                            * `gocardless` - GoCardless is a payment service provider.
                            * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                            * `moneris_us` - Moneris USA is a payment gateway.
                            * `moneris` - Moneris is a payment gateway.
                            * `bluesnap` - BlueSnap is a payment gateway.
                            * `cybersource` - CyberSource is a payment gateway.
                            * `vantiv` - Vantiv is a payment gateway.
                            * `checkout_com` - Checkout.com is a payment gateway.
                            * `paypal` - PayPal Commerce is a payment gateway.
                            * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                            * `exact` - Exact Payments is a payment gateway.
                            * `mollie` - Mollie is a payment gateway.
                            * `quickbooks` - Intuit QuickBooks Payments gateway
                            * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                            * `global_payments` - Global Payments is a payment service provider.
                            * `bank_of_america` - Bank of America Gateway
                            * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                            * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                            * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                            * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                            * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                            * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                            * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                            * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                            * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                            * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                            * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                            * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                            * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                            * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                            * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                            * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                            * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
                          enum:
                          - chargebee
                          - chargebee_payments
                          - adyen
                          - stripe
                          - wepay
                          - braintree
                          - authorize_net
                          - paypal_pro
                          - pin
                          - eway
                          - eway_rapid
                          - worldpay
                          - balanced_payments
                          - beanstream
                          - bluepay
                          - elavon
                          - first_data_global
                          - hdfc
                          - migs
                          - nmi
                          - ogone
                          - paymill
                          - paypal_payflow_pro
                          - sage_pay
                          - tco
                          - wirecard
                          - amazon_payments
                          - paypal_express_checkout
                          - gocardless
                          - orbital
                          - moneris_us
                          - moneris
                          - bluesnap
                          - cybersource
                          - vantiv
                          - checkout_com
                          - paypal
                          - ingenico_direct
                          - exact
                          - mollie
                          - quickbooks
                          - razorpay
                          - global_payments
                          - bank_of_america
                          - ecentric
                          - metrics_global
                          - windcave
                          - pay_com
                          - ebanx
                          - dlocal
                          - nuvei
                          - solidgate
                          - paystack
                          - jp_morgan
                          - deutsche_bank
                          - ezidebit
                          - twikey
                          - tempus
                          - moyasar
                          - payway
                          - not_applicable
                          example: null
                        in:
                          type: string
                          description: |-
                            * `chargebee` - Chargebee test gateway.
                            * `chargebee_payments` - Chargebee Payments gateway
                            * `adyen` - Adyen is a payment gateway.
                            * `stripe` - Stripe is a payment gateway.
                            * `wepay` - WePay is a payment gateway.
                            * `braintree` - Braintree is a payment gateway.
                            * `authorize_net` - Authorize.net is a payment gateway
                            * `paypal_pro` - PayPal Pro Account is a payment gateway.
                            * `pin` - Pin is a payment gateway
                            * `eway` - eWAY Account is a payment gateway.
                            * `eway_rapid` - eWAY Rapid is a payment gateway.
                            * `worldpay` - WorldPay is a payment gateway
                            * `balanced_payments` - Balanced is a payment gateway
                            * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                            * `bluepay` - BluePay is a payment gateway.
                            * `elavon` - Elavon Virtual Merchant is a payment solution.
                            * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                            * `hdfc` - HDFC Account is a payment gateway.
                            * `migs` - MasterCard Internet Gateway Service payment gateway.
                            * `nmi` - NMI is a payment gateway.
                            * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                            * `paymill` - PAYMILL is a payment gateway.
                            * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                            * `sage_pay` - Sage Pay is a payment gateway.
                            * `tco` - 2Checkout is a payment gateway.
                            * `wirecard` - WireCard Account is a payment service provider.
                            * `amazon_payments` - Amazon Payments is a payment service provider.
                            * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                            * `gocardless` - GoCardless is a payment service provider.
                            * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                            * `moneris_us` - Moneris USA is a payment gateway.
                            * `moneris` - Moneris is a payment gateway.
                            * `bluesnap` - BlueSnap is a payment gateway.
                            * `cybersource` - CyberSource is a payment gateway.
                            * `vantiv` - Vantiv is a payment gateway.
                            * `checkout_com` - Checkout.com is a payment gateway.
                            * `paypal` - PayPal Commerce is a payment gateway.
                            * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                            * `exact` - Exact Payments is a payment gateway.
                            * `mollie` - Mollie is a payment gateway.
                            * `quickbooks` - Intuit QuickBooks Payments gateway
                            * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                            * `global_payments` - Global Payments is a payment service provider.
                            * `bank_of_america` - Bank of America Gateway
                            * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                            * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                            * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                            * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                            * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                            * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                            * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                            * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                            * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                            * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                            * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                            * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                            * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                            * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                            * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                            * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                            * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
                          enum:
                          - chargebee
                          - chargebee_payments
                          - adyen
                          - stripe
                          - wepay
                          - braintree
                          - authorize_net
                          - paypal_pro
                          - pin
                          - eway
                          - eway_rapid
                          - worldpay
                          - balanced_payments
                          - beanstream
                          - bluepay
                          - elavon
                          - first_data_global
                          - hdfc
                          - migs
                          - nmi
                          - ogone
                          - paymill
                          - paypal_payflow_pro
                          - sage_pay
                          - tco
                          - wirecard
                          - amazon_payments
                          - paypal_express_checkout
                          - gocardless
                          - orbital
                          - moneris_us
                          - moneris
                          - bluesnap
                          - cybersource
                          - vantiv
                          - checkout_com
                          - paypal
                          - ingenico_direct
                          - exact
                          - mollie
                          - quickbooks
                          - razorpay
                          - global_payments
                          - bank_of_america
                          - ecentric
                          - metrics_global
                          - windcave
                          - pay_com
                          - ebanx
                          - dlocal
                          - nuvei
                          - solidgate
                          - paystack
                          - jp_morgan
                          - deutsche_bank
                          - ezidebit
                          - twikey
                          - tempus
                          - moyasar
                          - payway
                          - not_applicable
                          pattern: "^\\[(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable)(,(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `chargebee` - Chargebee test gateway.
                            * `chargebee_payments` - Chargebee Payments gateway
                            * `adyen` - Adyen is a payment gateway.
                            * `stripe` - Stripe is a payment gateway.
                            * `wepay` - WePay is a payment gateway.
                            * `braintree` - Braintree is a payment gateway.
                            * `authorize_net` - Authorize.net is a payment gateway
                            * `paypal_pro` - PayPal Pro Account is a payment gateway.
                            * `pin` - Pin is a payment gateway
                            * `eway` - eWAY Account is a payment gateway.
                            * `eway_rapid` - eWAY Rapid is a payment gateway.
                            * `worldpay` - WorldPay is a payment gateway
                            * `balanced_payments` - Balanced is a payment gateway
                            * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.
                            * `bluepay` - BluePay is a payment gateway.
                            * `elavon` - Elavon Virtual Merchant is a payment solution.
                            * `first_data_global` - First Data Global Gateway Virtual Terminal Account
                            * `hdfc` - HDFC Account is a payment gateway.
                            * `migs` - MasterCard Internet Gateway Service payment gateway.
                            * `nmi` - NMI is a payment gateway.
                            * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.
                            * `paymill` - PAYMILL is a payment gateway.
                            * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.
                            * `sage_pay` - Sage Pay is a payment gateway.
                            * `tco` - 2Checkout is a payment gateway.
                            * `wirecard` - WireCard Account is a payment service provider.
                            * `amazon_payments` - Amazon Payments is a payment service provider.
                            * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.
                            * `gocardless` - GoCardless is a payment service provider.
                            * `orbital` - Chase Paymentech(Orbital) is a payment gateway.
                            * `moneris_us` - Moneris USA is a payment gateway.
                            * `moneris` - Moneris is a payment gateway.
                            * `bluesnap` - BlueSnap is a payment gateway.
                            * `cybersource` - CyberSource is a payment gateway.
                            * `vantiv` - Vantiv is a payment gateway.
                            * `checkout_com` - Checkout.com is a payment gateway.
                            * `paypal` - PayPal Commerce is a payment gateway.
                            * `ingenico_direct` - Worldline Online Payments is a payment gateway.
                            * `exact` - Exact Payments is a payment gateway.
                            * `mollie` - Mollie is a payment gateway.
                            * `quickbooks` - Intuit QuickBooks Payments gateway
                            * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
                            * `global_payments` - Global Payments is a payment service provider.
                            * `bank_of_america` - Bank of America Gateway
                            * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
                            * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.
                            * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
                            * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.<span isMicro='true' featureId='cb-pay-com'></span>
                            * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.<span isMicro='true' featureId='cb-ebanx'></span>
                            * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.
                            * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-nuvei'></span>
                            * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. <span isMicro='true' featureId='cb-solidgate'></span>
                            * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. <span isMicro='true' featureId='cb-paystack'></span>
                            * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. <span isMicro='true' featureId='cb-jp-morgan'></span>
                            * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. <span isMicro='true' featureId='cb-deutsche-bank'></span>
                            * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div>
                            * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions.
                            * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization.
                            * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure
                            * `payway` - Payway is a payment gateway that enables secure card and payment acceptance.
                            * `not_applicable` - Indicates that payment gateway is not applicable for this resource.
                          enum:
                          - chargebee
                          - chargebee_payments
                          - adyen
                          - stripe
                          - wepay
                          - braintree
                          - authorize_net
                          - paypal_pro
                          - pin
                          - eway
                          - eway_rapid
                          - worldpay
                          - balanced_payments
                          - beanstream
                          - bluepay
                          - elavon
                          - first_data_global
                          - hdfc
                          - migs
                          - nmi
                          - ogone
                          - paymill
                          - paypal_payflow_pro
                          - sage_pay
                          - tco
                          - wirecard
                          - amazon_payments
                          - paypal_express_checkout
                          - gocardless
                          - orbital
                          - moneris_us
                          - moneris
                          - bluesnap
                          - cybersource
                          - vantiv
                          - checkout_com
                          - paypal
                          - ingenico_direct
                          - exact
                          - mollie
                          - quickbooks
                          - razorpay
                          - global_payments
                          - bank_of_america
                          - ecentric
                          - metrics_global
                          - windcave
                          - pay_com
                          - ebanx
                          - dlocal
                          - nuvei
                          - solidgate
                          - paystack
                          - jp_morgan
                          - deutsche_bank
                          - ezidebit
                          - twikey
                          - tempus
                          - moyasar
                          - payway
                          - not_applicable
                          pattern: "^\\[(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable)(,(chargebee|chargebee_payments|adyen|stripe|wepay|braintree|authorize_net|paypal_pro|pin|eway|eway_rapid|worldpay|balanced_payments|beanstream|bluepay|elavon|first_data_global|hdfc|migs|nmi|ogone|paymill|paypal_payflow_pro|sage_pay|tco|wirecard|amazon_payments|paypal_express_checkout|gocardless|orbital|moneris_us|moneris|bluesnap|cybersource|vantiv|checkout_com|paypal|ingenico_direct|exact|mollie|quickbooks|razorpay|global_payments|bank_of_america|ecentric|metrics_global|windcave|pay_com|ebanx|dlocal|nuvei|solidgate|paystack|jp_morgan|deutsche_bank|ezidebit|twikey|tempus|moyasar|payway|not_applicable))*\\\
                            ]$"
                          example: null
                    gateway_account_id:
                      type: object
                      deprecated: false
                      description: |
                        The gateway account used for this transaction
                      example: gw_3Nl9BNeQ7438Ks1
                      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
                    id_at_gateway:
                      type: object
                      deprecated: false
                      description: |
                        The id with which this transaction is referred in gateway.
                      example: txn_5678HJS89900
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    reference_number:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code>
                        = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
                        .</p>
                      example: cus_u239732
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    type:
                      type: object
                      deprecated: false
                      description: |
                        Type of the transaction.
                      example: payment
                      properties:
                        is:
                          type: string
                          description: |-
                            * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment_reversal` - Indicates a reversal transaction.
                          enum:
                          - authorization
                          - payment
                          - refund
                          - payment_reversal
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment_reversal` - Indicates a reversal transaction.
                          enum:
                          - authorization
                          - payment
                          - refund
                          - payment_reversal
                          example: null
                        in:
                          type: string
                          description: |-
                            * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment_reversal` - Indicates a reversal transaction.
                          enum:
                          - authorization
                          - payment
                          - refund
                          - payment_reversal
                          pattern: "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>.
                            * `payment_reversal` - Indicates a reversal transaction.
                          enum:
                          - authorization
                          - payment
                          - refund
                          - payment_reversal
                          pattern: "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\\
                            ]$"
                          example: null
                    date:
                      type: object
                      deprecated: false
                      description: |
                        Indicates when this transaction occurred.
                      example: "1435054328"
                      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
                    amount:
                      type: object
                      deprecated: false
                      description: |
                        Amount for this transaction.
                      example: "1200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_capturable:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on transaction's unused authorized/blocked amount.
                      example: "1200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        The status of this transaction.
                      example: success
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
                          enum:
                          - in_progress
                          - success
                          - voided
                          - failure
                          - timeout
                          - needs_attention
                          - late_failure
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
                          enum:
                          - in_progress
                          - success
                          - voided
                          - failure
                          - timeout
                          - needs_attention
                          - late_failure
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
                          enum:
                          - in_progress
                          - success
                          - voided
                          - failure
                          - timeout
                          - needs_attention
                          - late_failure
                          pattern: "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.
                          enum:
                          - in_progress
                          - success
                          - voided
                          - failure
                          - timeout
                          - needs_attention
                          - late_failure
                          pattern: "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\\
                            ]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                  example: null
              example: null
            encoding:
              transaction:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/invoices:
    post:
      summary: Export Invoices
      description: "This API triggers export of invoice data. The exported zip file\
        \ contains CSV files with invoice-related data.\n\n### Invoice Export Best\
        \ Practice\n\nFor a full export, Chargebee recommends exporting data in batches\
        \ by using date filters. The table below provides examples of how to set the\
        \ filters:  \n\n|                 **Scenario**                  |        \
        \                **Filter Example**                        |             \
        \   **Description**                |\n|-----------------------------------------------|------------------------------------------------------------------|-----------------------------------------------|\n\
        | Export invoices updated after January 1, 2024 | *invoice\\[updated_at\\\
        ]\\[after\\] = \"1704067200\"*                  | Export invoices from January\
        \ 1, 2024 onwards. |\n| Export invoices for 2023                      | *invoice\\\
        [updated_at\\]\\[between\\] = \"\\[1672531200,1704067199\\]\"* | Export all\
        \ invoices for the year 2023.        |\n| Export invoices for 2022       \
        \               | *invoice\\[updated_at\\]\\[between\\] = \"\\[1640995200,1672531199\\\
        ]\"* | Export all invoices for the year 2022.        |\n\nIf the export still\
        \ fails, further reduce the date range, for example:  \n\n|            **Scenario**\
        \            |                        **Filter Example**                 \
        \       |                           **Description**                      \
        \      |\n|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|\n\
        | Export for the second half of 2024 | *invoice\\[updated_at\\]\\[after\\\
        ] = \"1717200000\"*                  | Export invoices are updated after June\
        \ 1, 2024.                      |\n| Export for the first half of 2024  |\
        \ *invoice\\[updated_at\\]\\[between\\] = \"\\[1704067200,1717199999\\]\"\
        * | Export invoices updated between January 1, 2024, and May 31, 2024.   |\n\
        | Export for the second half of 2023 | *invoice\\[updated_at\\]\\[between\\\
        ] = \"\\[1685577600,1704067199\\]\"* | Export invoices updated between June\
        \ 1, 2023, and December 31, 2023. |\n| Export for the first half of 2023 \
        \ | *invoice\\[updated_at\\]\\[between\\] = \"\\[1672531200,1685577599\\]\"\
        * | Export invoices updated between January 1, 2023, and May 31, 2023.   |\n\
        \n**Note**\n\nThe date ranges in the examples above are just suggestions;\
        \ you can adjust the date window to fit your specific needs. If an export\
        \ fails due to large data volume, reduce the date window further and retry\
        \ the export.\n"
      operationId: export_invoices
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                payment_owner:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Payment owner of an invoice. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*payment_owner\\\[is\\\] = "payment_customer"\*
                  example: payment_customer
                  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
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        The invoice number. Acts as a identifier for invoice and typically generated sequentially.
                      example: INVOICE_654
                      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
                    subscription_id:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on subscription_id. NOTE: Not to be used if \*consolidated invoicing\* is enabled.
                      example: 3bdjnDnsdQn
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        The identifier of the customer this invoice belongs to.
                      example: 3bdjnDnsdQn
                      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
                    recurring:
                      type: object
                      deprecated: false
                      description: |
                        Boolean indicating whether this invoice belongs to a subscription
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current status of this invoice.
                      example: paid
                      properties:
                        is:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                    price_type:
                      type: object
                      deprecated: false
                      description: |
                        The price type of the invoice.
                      example: tax_exclusive
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                    date:
                      type: object
                      deprecated: false
                      description: |
                        The document date displayed on the invoice PDF.
                      example: "1394532759"
                      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
                    paid_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating the date \\\& time this invoice got paid.
                      example: "1394532759"
                      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
                    total:
                      type: object
                      deprecated: false
                      description: |
                        Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_paid:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
                        for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
                        that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</p>
                      example: "800"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_adjusted:
                      type: object
                      deprecated: false
                      description: |
                        Total adjustments made against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    credits_applied:
                      type: object
                      deprecated: false
                      description: |
                        Total credits applied against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_due:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code>
                        </li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.</li>
                        </ul>
                      example: "200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    dunning_status:
                      type: object
                      deprecated: false
                      description: |
                        Current dunning status of the invoice.
                      example: in_progress
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response. <a href="/docs/api/v2/pcv-1/exports">Learn more</a> about the best practice before performing full export.</p>
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
              example: null
            encoding:
              invoice:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/{export-id}:
    get:
      summary: Retrieve an export
      description: |
        This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it's shared.

        **Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
      operationId: retrieve_an_export
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: export-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/export-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/deferred_revenue:
    post:
      summary: Export Deferred Revenue Reports
      description: |
        **Important:**
        This report is deprecated. Therefore, the endpoint is also deprecated.

        This API triggers export for the Deferred Revenue Report.

        **Note:**
        This API call is asynchronous.
        You need to check if this operation has completed by checking if the export status is **completed**
        . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion**
        function provided as an instance method in the library.
        You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
      operationId: export_deferred_revenue_reports
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                report_by:
                  type: string
                  deprecated: false
                  description: |
                    Determines the scope of the report. Returns the report based on the value specified.
                    \* subscription -

                    Subscription
                    \* invoice -

                    Invoice
                    \* product -

                    Product (Includes Plan, Addon and Adhoc)
                    \* customer -

                    Customer
                  enum:
                  - customer
                  - invoice
                  - product
                  - subscription
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    Value must be in ISO 4217 format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
                  maxLength: 3
                  example: null
                report_from_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified month, combined with the value specified for report_from_year.Values must be between 1 and 12, where 1 is January and 12 is December.
                  example: null
                report_from_year:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified year, combined with the value specified for report_from_month.
                  example: null
                report_to_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified month, combined with the value specified for report_to_year.Values must be between 1 and 12, where 1 is January and 12 is December.
                  example: null
                report_to_year:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data until the specified year, combined with the value specified for report_to_month.
                  example: null
                include_discounts:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Returns amount with discount in the report. If value specified is false, it returns amount without discount.
                  example: null
                payment_owner:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Payment owner of an invoice. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*payment_owner\\\[is\\\] = "payment_customer"\*
                  example: payment_customer
                  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
                cancel_reason_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \*\*Settings \\\> Configure Chargebee \\\> Reason Codes \\\> Subscriptions \\\> Subscription Cancellation\*\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*cancel_reason_code\\\[is_not\\\] = "Not Paid"\*
                  example: Not Paid
                  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
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \*\*Note\*\* \[Multiple Business Entities\](/docs/api/getting-started) is a feature available only on Product Catalog 2.0. \*\*Supported operators :\*\* is, is_not, starts_with \*\*Example →\*\* \*business_entity_id\\\[is\\\] = "business_entity_id"\*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_not:
                      type: string
                      minLength: 1
                      example: null
                    starts_with:
                      type: string
                      minLength: 1
                      example: null
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        The invoice number. Acts as a identifier for invoice and typically generated sequentially.
                      example: INVOICE_654
                      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
                    recurring:
                      type: object
                      deprecated: false
                      description: |
                        Boolean indicating whether this invoice belongs to a subscription
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current status of this invoice.
                      example: paid
                      properties:
                        is:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                    price_type:
                      type: object
                      deprecated: false
                      description: |
                        The price type of the invoice.
                      example: tax_exclusive
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                    date:
                      type: object
                      deprecated: false
                      description: |
                        The document date displayed on the invoice PDF.
                      example: "1394532759"
                      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
                    paid_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating the date \\\& time this invoice got paid.
                      example: "1394532759"
                      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
                    total:
                      type: object
                      deprecated: false
                      description: |
                        Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_paid:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
                        for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
                        that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</p>
                      example: "800"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_adjusted:
                      type: object
                      deprecated: false
                      description: |
                        Total adjustments made against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    credits_applied:
                      type: object
                      deprecated: false
                      description: |
                        Total credits applied against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_due:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code>
                        </li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.</li>
                        </ul>
                      example: "200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    dunning_status:
                      type: object
                      deprecated: false
                      description: |
                        Current dunning status of the invoice.
                      example: in_progress
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      example: 8gsnbYfsMLds
                      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
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer with whom this subscription is associated.
                      example: 8gsnbYfsMLds
                      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
                    plan_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      example: basic
                      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
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current state of the subscription
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                    cancel_reason:
                      type: object
                      deprecated: false
                      description: |
                        The reason for canceling the subscription. Set by Chargebee automatically.
                      example: not_paid
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    remaining_billing_cycles:
                      type: object
                      deprecated: false
                      description: |
                        \* When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. \* When the subscription is on a \[contract term\](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
                      example: "3"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the subscription was created.
                      example: "1435054328"
                      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
                    activated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Time at which the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        last changed to
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>.
                        For example, this value is updated when an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        or
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        subscription activates.</p>
                      example: "1435054328"
                      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
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    next_billing_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>
                        unless multiple subscription terms were invoiced in advance using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                        parameter.</p>
                      example: "1435054328"
                      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
                    cancelled_at:
                      type: object
                      deprecated: false
                      description: |
                        Time at which subscription was cancelled or is set to be cancelled.
                      example: "1435054328"
                      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
                    has_scheduled_changes:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , there are subscription changes scheduled on next renewal.</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        to override for this subscription, the <a href="https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a>
                        for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>
                        .</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      example: 9bsvnHgsvmsI
                      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
                    first_name:
                      type: object
                      deprecated: false
                      description: |
                        First name of the customer
                      example: John
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    last_name:
                      type: object
                      deprecated: false
                      description: |
                        Last name of the customer
                      example: Clint
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    email:
                      type: object
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      example: john@test.com
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    company:
                      type: object
                      deprecated: false
                      description: |
                        Company name of the customer.
                      example: Globex Corp
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    phone:
                      type: object
                      deprecated: false
                      description: |
                        Phone number of the customer
                      example: (541) 754-3010
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    auto_collection:
                      type: object
                      deprecated: false
                      description: |
                        Whether payments needs to be collected automatically for this customer
                      example: "on"
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                    taxability:
                      type: object
                      deprecated: false
                      description: |
                        Specifies if the customer is liable for tax
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating when this customer resource is created.
                      example: "1435054328"
                      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
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the customer.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |
                        Override for this customer, the \[site-level setting\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \[subscription level\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                relationship:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for relationship
                  properties:
                    parent_id:
                      type: object
                      deprecated: false
                      description: |
                        Immediate parent with whom we will link our new customer(child)
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    payment_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to pay
                      example: active1
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    invoice_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to handle invoices
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                  example: null
              required:
              - report_by
              - report_from_month
              - report_from_year
              - report_to_month
              - report_to_year
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              relationship:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/revenue_recognition:
    post:
      summary: Export Revenue Recognition Reports
      description: |
        **Important:**
        This report is deprecated. Therefore, the endpoint is also deprecated.

        This API triggers export for the revenue recognition report.

        **Note:**
        This API call is asynchronous.
        You need to check if this operation has completed by checking if the export status is **completed**
        . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion**
        function provided as an instance method in the library.
        You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
      operationId: export_revenue_recognition_reports
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                report_by:
                  type: string
                  deprecated: false
                  description: |
                    Determines the scope of the report. Returns the report based on the value specified.
                    \* subscription -

                    Subscription
                    \* invoice -

                    Invoice
                    \* product -

                    Product (Includes Plan, Addon and Adhoc)
                    \* customer -

                    Customer
                  enum:
                  - customer
                  - invoice
                  - product
                  - subscription
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    Value must be in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
                    format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
                  maxLength: 3
                  example: null
                report_from_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified month, combined with the value specified for report_from_year. Values must be between 1 and 12, where 1 is January and 12 is December.
                  example: null
                report_from_year:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified year, combined with the value specified for report_from_month.
                  example: null
                report_to_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data from the specified month, combined with the value specified for report_to_year. Values must be between 1 and 12, where 1 is January and 12 is December.
                  example: null
                report_to_year:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Obtains report data until the specified year, combined with the value specified for report_to_month.
                  example: null
                include_discounts:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Returns amount with discount in the report. If value specified is false, it returns amount without discount.
                  example: null
                payment_owner:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Payment owner of an invoice. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*payment_owner\\\[is_not\\\] = "payment_customer"\*
                  example: payment_customer
                  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
                cancel_reason_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \*\*Settings \\\> Configure Chargebee \\\> Reason Codes \\\> Subscriptions \\\> Subscription Cancellation\*\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*cancel_reason_code\\\[is_not\\\] = "Not Paid"\*
                  example: Not Paid
                  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
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \*\*Note\*\* \[Multiple Business Entities\](/docs/api/getting-started) is a feature available only on Product Catalog 2.0. \*\*Supported operators :\*\* is, is_not, starts_with \*\*Example →\*\* \*business_entity_id\\\[is\\\] = "business_entity_id"\*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_not:
                      type: string
                      minLength: 1
                      example: null
                    starts_with:
                      type: string
                      minLength: 1
                      example: null
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        The invoice number. Acts as a identifier for invoice and typically generated sequentially.
                      example: INVOICE_654
                      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
                    recurring:
                      type: object
                      deprecated: false
                      description: |
                        Boolean indicating whether this invoice belongs to a subscription
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current status of this invoice.
                      example: paid
                      properties:
                        is:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `paid` - Indicates a paid invoice.
                            * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                            * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.
                            * `not_paid` - Indicates the payment is not made and all attempts to collect is failed.
                            * `voided` - Indicates a voided invoice.
                            * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          pattern: "^\\[(paid|posted|payment_due|not_paid|voided|pending)(,(paid|posted|payment_due|not_paid|voided|pending))*\\\
                            ]$"
                          example: null
                    price_type:
                      type: object
                      deprecated: false
                      description: |
                        The price type of the invoice.
                      example: tax_exclusive
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                    date:
                      type: object
                      deprecated: false
                      description: |
                        The document date displayed on the invoice PDF.
                      example: "1394532759"
                      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
                    paid_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating the date \\\& time this invoice got paid.
                      example: "1394532759"
                      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
                    total:
                      type: object
                      deprecated: false
                      description: |
                        Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_paid:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
                        for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
                        that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</p>
                      example: "800"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_adjusted:
                      type: object
                      deprecated: false
                      description: |
                        Total adjustments made against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    credits_applied:
                      type: object
                      deprecated: false
                      description: |
                        Total credits applied against this invoice.
                      example: "100"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_due:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p>
                        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">
                        <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code>
                        </li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li>
                        <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.</li>
                        </ul>
                      example: "200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    dunning_status:
                      type: object
                      deprecated: false
                      description: |
                        Current dunning status of the invoice.
                      example: in_progress
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.
                          enum:
                          - in_progress
                          - exhausted
                          - stopped
                          - success
                          pattern: "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      example: 8gsnbYfsMLds
                      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
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer with whom this subscription is associated.
                      example: 8gsnbYfsMLds
                      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
                    plan_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      example: basic
                      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
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current state of the subscription
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                    cancel_reason:
                      type: object
                      deprecated: false
                      description: |
                        The reason for canceling the subscription. Set by Chargebee automatically.
                      example: not_paid
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    remaining_billing_cycles:
                      type: object
                      deprecated: false
                      description: |
                        \* When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. \* When the subscription is on a \[contract term\](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
                      example: "3"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the subscription was created.
                      example: "1435054328"
                      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
                    activated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Time at which the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        last changed to
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>.
                        For example, this value is updated when an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        or
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        subscription activates.</p>
                      example: "1435054328"
                      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
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    next_billing_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>
                        unless multiple subscription terms were invoiced in advance using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                        parameter.</p>
                      example: "1435054328"
                      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
                    cancelled_at:
                      type: object
                      deprecated: false
                      description: |
                        Time at which subscription was cancelled or is set to be cancelled.
                      example: "1435054328"
                      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
                    has_scheduled_changes:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , there are subscription changes scheduled on next renewal.</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        to override for this subscription, the <a href="https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a>
                        for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>
                        .</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer.
                      example: 9bsvnHgsvmsI
                      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
                    first_name:
                      type: object
                      deprecated: false
                      description: |
                        First name of the customer
                      example: John
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    last_name:
                      type: object
                      deprecated: false
                      description: |
                        Last name of the customer
                      example: Clint
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    email:
                      type: object
                      deprecated: false
                      description: |
                        Email of the customer. Configured email notifications will be sent to this email.
                      example: john@test.com
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    company:
                      type: object
                      deprecated: false
                      description: |
                        Company name of the customer.
                      example: Globex Corp
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    phone:
                      type: object
                      deprecated: false
                      description: |
                        Phone number of the customer
                      example: (541) 754-3010
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    auto_collection:
                      type: object
                      deprecated: false
                      description: |
                        Whether payments needs to be collected automatically for this customer
                      example: "on"
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`on\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* \`off\` - Automatic collection of charges will not be made. All payments must be recorded offline.
                          enum:
                          - "on"
                          - "off"
                          pattern: "^\\[(on|off)(,(on|off))*\\]$"
                          example: null
                    taxability:
                      type: object
                      deprecated: false
                      description: |
                        Specifies if the customer is liable for tax
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          example: null
                        in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `taxable` - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
                            * `exempt` - <ul><li>Customer is exempted from tax. When using Chargebee’s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li><li>However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code>entity_code</code> or <code>exempt_number</code> attributes if you use Chargebee’s <a target="_blank" href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption">AvaTax for Sales</a> or specify <code>exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee’s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code>entity_code</code>/<code>exempt_number</code>/<code>exemption_details</code> based on the state/region/province of the taxable address.</li></ul>
                          enum:
                          - taxable
                          - exempt
                          pattern: "^\\[(taxable|exempt)(,(taxable|exempt))*\\]$"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating when this customer resource is created.
                      example: "1435054328"
                      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
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the customer.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |
                        Override for this customer, the \[site-level setting\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \[subscription level\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
                relationship:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for relationship
                  properties:
                    parent_id:
                      type: object
                      deprecated: false
                      description: |
                        Immediate parent with whom we will link our new customer(child)
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    payment_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to pay
                      example: active1
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    invoice_owner_id:
                      type: object
                      deprecated: false
                      description: |
                        Parent who is going to handle invoices
                      example: future_billing
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                  example: null
              required:
              - report_by
              - report_from_month
              - report_from_year
              - report_to_month
              - report_to_year
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              relationship:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/credit_notes:
    post:
      summary: Export Credit Notes
      description: |
        This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
      operationId: export_credit_notes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                credit_note:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for credit_note
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Credit-note id.
                      example: CN_123
                      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
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        The identifier of the customer this Credit Note belongs to.
                      example: 4gmiXbsjdm
                      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
                    subscription_id:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on subscription_id. NOTE: Not to be used if \*consolidated invoicing\* feature is enabled.
                      example: 4gmiXbsjdm
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    reference_invoice_id:
                      type: object
                      deprecated: false
                      description: |
                        The identifier of the invoice against which this Credit Note is issued
                      example: INVOICE_876
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    type:
                      type: object
                      deprecated: false
                      description: |
                        The credit note type. \[Learn more\](/docs/api/v2/pcv-1/credit_notes/credit-note-object) about credit note types.
                      example: adjustment
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
                          enum:
                          - adjustment
                          - refundable
                          - store
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
                          enum:
                          - adjustment
                          - refundable
                          - store
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
                          enum:
                          - adjustment
                          - refundable
                          - store
                          pattern: "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note
                          enum:
                          - adjustment
                          - refundable
                          - store
                          pattern: "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\\
                            ]$"
                          example: null
                    reason_code:
                      type: object
                      deprecated: false
                      description: |
                        The reason for issuing this Credit Note. The following reason codes are supported now\\\[Deprecated; use the \[create_reason_code\](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\\\]
                      example: waiver
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
                          enum:
                          - write_off
                          - subscription_change
                          - subscription_cancellation
                          - subscription_pause
                          - chargeback
                          - product_unsatisfactory
                          - service_unsatisfactory
                          - order_change
                          - order_cancellation
                          - waiver
                          - other
                          - fraudulent
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
                          enum:
                          - write_off
                          - subscription_change
                          - subscription_cancellation
                          - subscription_pause
                          - chargeback
                          - product_unsatisfactory
                          - service_unsatisfactory
                          - order_change
                          - order_cancellation
                          - waiver
                          - other
                          - fraudulent
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
                          enum:
                          - write_off
                          - subscription_change
                          - subscription_cancellation
                          - subscription_pause
                          - chargeback
                          - product_unsatisfactory
                          - service_unsatisfactory
                          - order_change
                          - order_cancellation
                          - waiver
                          - other
                          - fraudulent
                          pattern: "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT
                          enum:
                          - write_off
                          - subscription_change
                          - subscription_cancellation
                          - subscription_pause
                          - chargeback
                          - product_unsatisfactory
                          - service_unsatisfactory
                          - order_change
                          - order_cancellation
                          - waiver
                          - other
                          - fraudulent
                          pattern: "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\\
                            ]$"
                          example: null
                    create_reason_code:
                      type: object
                      deprecated: false
                      description: |
                        Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in \*\*Settings \\\> Configure Chargebee \\\> Reason Codes \\\> Credit Notes \\\> Create Credit Note\*\*. Must be passed if set as mandatory in the app. The codes are case-sensitive
                      example: Other
                      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
                    status:
                      type: object
                      deprecated: false
                      description: |
                        The credit note status.
                      example: adjusted
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
                          enum:
                          - adjusted
                          - refunded
                          - refund_due
                          - voided
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
                          enum:
                          - adjusted
                          - refunded
                          - refund_due
                          - voided
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
                          enum:
                          - adjusted
                          - refunded
                          - refund_due
                          - voided
                          pattern: "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.
                          enum:
                          - adjusted
                          - refunded
                          - refund_due
                          - voided
                          pattern: "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\\
                            ]$"
                          example: null
                    date:
                      type: object
                      deprecated: false
                      description: |
                        The date the Credit Note is issued.
                      example: "1435054328"
                      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
                    total:
                      type: object
                      deprecated: false
                      description: |
                        Credit Note amount in cents.
                      example: "1200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    price_type:
                      type: object
                      deprecated: false
                      description: |
                        The price type of the Credit Note.
                      example: tax_exclusive
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                    amount_allocated:
                      type: object
                      deprecated: false
                      description: |
                        The amount allocated to the invoices.
                      example: "1200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_refunded:
                      type: object
                      deprecated: false
                      description: |
                        The refunds issued from this Credit Note.
                      example: "130"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    amount_available:
                      type: object
                      deprecated: false
                      description: |
                        The yet to be used credits of this Credit Note.
                      example: "1400"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    voided_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating the date and time this Credit Note gets voided.
                      example: "1435054328"
                      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
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
              example: null
            encoding:
              credit_note:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/coupons:
    post:
      summary: Export Coupons
      description: |
        This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.
      operationId: export_coupons
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The currency code (\[ISO 4217 format\](https://www.chargebee.com/docs/supported-currencies.html) ) of the coupon. Applicable for \*fixed_amount\* coupons alone. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*currency_code\\\[is\\\] = "USD"\*
                  example: USD
                  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
                applicable_item_price_ids:
                  type: object
                  deprecated: false
                  description: |
                    List of itemPrice ids for which these coupons are applicable.
                  example: day-pass-USD
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    in:
                      type: string
                      pattern: "^\\[(.*)(,.*)*\\]$"
                      example: null
                coupon:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for coupon
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the coupon ID contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the coupon ID in the path parameter before making an API call.</p></div>
                      example: OFF2008
                      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:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The display name used in web interface for identifying the coupon.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the name of the coupon set contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the name of the coupon set in the path parameter before making an API call.</p></div>
                      example: Offer 10
                      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
                    discount_type:
                      type: object
                      deprecated: false
                      description: |
                        The type of deduction
                      example: fixed_amount
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
                          enum:
                          - fixed_amount
                          - percentage
                          - offer_quantity
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
                          enum:
                          - fixed_amount
                          - percentage
                          - offer_quantity
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
                          enum:
                          - fixed_amount
                          - percentage
                          - offer_quantity
                          pattern: "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`fixed_amount\` - The specified amount will be deducted. \* \`percentage\` - The specified percentage will be deducted. \* \`offer_quantity\` - The specified units will be offered without any deduction.
                          enum:
                          - fixed_amount
                          - percentage
                          - offer_quantity
                          pattern: "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\\
                            ]$"
                          example: null
                    duration_type:
                      type: object
                      deprecated: false
                      description: |
                        Specifies the time duration for which this coupon is attached to the subscription.
                      example: forever
                      properties:
                        is:
                          type: string
                          description: "* `one_time` - The coupon stays attached to\
                            \ the subscription till it is applied on an invoice <b>once</b>.\
                            \ It is removed after that from the subscription.\n* `forever`\
                            \ - The coupon is attached to the subscription and applied\
                            \ on the invoices until explicitly removed.\n* `limited_period`\
                            \ - The discount is attached to the subscription and applied\
                            \ on the invoices for a limited duration. This duration\
                            \ starts from the point it is applied to an invoice for\
                            \ the first time and expires after a period specified\
                            \ by <code>period</code> and <code>period_unit</code>. "
                          enum:
                          - one_time
                          - forever
                          - limited_period
                          example: null
                        is_not:
                          type: string
                          description: "* `one_time` - The coupon stays attached to\
                            \ the subscription till it is applied on an invoice <b>once</b>.\
                            \ It is removed after that from the subscription.\n* `forever`\
                            \ - The coupon is attached to the subscription and applied\
                            \ on the invoices until explicitly removed.\n* `limited_period`\
                            \ - The discount is attached to the subscription and applied\
                            \ on the invoices for a limited duration. This duration\
                            \ starts from the point it is applied to an invoice for\
                            \ the first time and expires after a period specified\
                            \ by <code>period</code> and <code>period_unit</code>. "
                          enum:
                          - one_time
                          - forever
                          - limited_period
                          example: null
                        in:
                          type: string
                          description: "* `one_time` - The coupon stays attached to\
                            \ the subscription till it is applied on an invoice <b>once</b>.\
                            \ It is removed after that from the subscription.\n* `forever`\
                            \ - The coupon is attached to the subscription and applied\
                            \ on the invoices until explicitly removed.\n* `limited_period`\
                            \ - The discount is attached to the subscription and applied\
                            \ on the invoices for a limited duration. This duration\
                            \ starts from the point it is applied to an invoice for\
                            \ the first time and expires after a period specified\
                            \ by <code>period</code> and <code>period_unit</code>. "
                          enum:
                          - one_time
                          - forever
                          - limited_period
                          pattern: "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "* `one_time` - The coupon stays attached to\
                            \ the subscription till it is applied on an invoice <b>once</b>.\
                            \ It is removed after that from the subscription.\n* `forever`\
                            \ - The coupon is attached to the subscription and applied\
                            \ on the invoices until explicitly removed.\n* `limited_period`\
                            \ - The discount is attached to the subscription and applied\
                            \ on the invoices for a limited duration. This duration\
                            \ starts from the point it is applied to an invoice for\
                            \ the first time and expires after a period specified\
                            \ by <code>period</code> and <code>period_unit</code>. "
                          enum:
                          - one_time
                          - forever
                          - limited_period
                          pattern: "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\\
                            ]$"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Status of the coupon.
                      example: active
                      properties:
                        is:
                          type: string
                          description: |-
                            * `active` - Can be applied to a subscription.
                            * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                            * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                            * `deleted` - Indicates the coupon has been deleted.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `active` - Can be applied to a subscription.
                            * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                            * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                            * `deleted` - Indicates the coupon has been deleted.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          example: null
                        in:
                          type: string
                          description: |-
                            * `active` - Can be applied to a subscription.
                            * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                            * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                            * `deleted` - Indicates the coupon has been deleted.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          pattern: "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `active` - Can be applied to a subscription.
                            * `expired` - Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons?#coupon_max_redemptions">max_redemptions</a></code> or <code><a href="/docs/api/coupons?#coupon_valid_till">valid_till</a></code> date is past. Existing associations remain unaffected.
                            * `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.
                            * `deleted` - Indicates the coupon has been deleted.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          pattern: "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\\
                            ]$"
                          example: null
                    apply_on:
                      type: object
                      deprecated: false
                      description: |
                        The amount on the invoice to which the coupon is applied.
                      example: invoice_amount
                      properties:
                        is:
                          type: string
                          description: |-
                            * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                            * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                            * `each_specified_item` - <div prod_cat_ver="2">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                            </div>
                            <div prod_cat_ver="1">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                            </div>
                            * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
                          enum:
                          - invoice_amount
                          - each_specified_item
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                            * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                            * `each_specified_item` - <div prod_cat_ver="2">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                            </div>
                            <div prod_cat_ver="1">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                            </div>
                            * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
                          enum:
                          - invoice_amount
                          - each_specified_item
                          example: null
                        in:
                          type: string
                          description: |-
                            * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                            * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                            * `each_specified_item` - <div prod_cat_ver="2">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                            </div>
                            <div prod_cat_ver="1">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                            </div>
                            * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
                          enum:
                          - invoice_amount
                          - each_specified_item
                          pattern: "^\\[(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items)(,(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `invoice_amount` - The coupon is applied to the invoice <code>sub_total</code>.
                            * `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.
                            * `each_specified_item` - <div prod_cat_ver="2">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the item price specified by <code>item_price_id</code>.
                            </div>
                            <div prod_cat_ver="1">
                                The coupon is applied to the <code>invoice.line_item.amount</code> that corresponds to the plan or addon specified by <code>plan_ids</code> and <code>addon_ids</code>.
                            </div>
                            * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.
                          enum:
                          - invoice_amount
                          - each_specified_item
                          pattern: "^\\[(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items)(,(invoice_amount|specified_items_total|each_specified_item|each_unit_of_specified_items))*\\\
                            ]$"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        Timestamp indicating when this coupon is created.
                      example: "145222875"
                      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
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
                      example: "1243545465"
                      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
                  example: null
              example: null
            encoding:
              coupon:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/orders:
    post:
      summary: Export Orders
      description: |
        This API triggers export of order data. The exported zip file contains CSV files with order-related data.
      operationId: export_orders
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                total:
                  type: object
                  deprecated: false
                  description: |
                    optional, in cents filter Total amount charged for the order. \*\*Supported operators :\*\* is, is_not, lt, lte, gt, gte, between \*\*Example →\*\* \*total\\\[gt\\\] = "1394532759"\*
                  example: "1394532759"
                  properties:
                    is:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    is_not:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    lt:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    lte:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    gt:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    gte:
                      type: string
                      format: number
                      pattern: ^-?\d+$
                      example: null
                    between:
                      type: string
                      pattern: "^\\[-?\\d+,-?\\d+\\]$"
                      example: null
                order:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for order
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Uniquely identifies the order. It is the api identifier for the order
                      example: "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
                    subscription_id:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on subscription_id.
                      example: 3bdjnDnsdQn
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        The customer for which the order is created
                      example: 3bdjnDnsdQn
                      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
                    status:
                      type: object
                      deprecated: false
                      description: |
                        The status of this order.
                      example: paid
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
                          enum:
                          - new
                          - processing
                          - complete
                          - cancelled
                          - voided
                          - queued
                          - awaiting_shipment
                          - on_hold
                          - delivered
                          - shipped
                          - partially_delivered
                          - returned
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
                          enum:
                          - new
                          - processing
                          - complete
                          - cancelled
                          - voided
                          - queued
                          - awaiting_shipment
                          - on_hold
                          - delivered
                          - shipped
                          - partially_delivered
                          - returned
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
                          enum:
                          - new
                          - processing
                          - complete
                          - cancelled
                          - voided
                          - queued
                          - awaiting_shipment
                          - on_hold
                          - delivered
                          - shipped
                          - partially_delivered
                          - returned
                          pattern: "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`new\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \* \`processing\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \* \`complete\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \* \`cancelled\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \* \`voided\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \* \`queued\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \* \`awaiting_shipment\` - The order has been picked up by an integration system, and synced to a shipping management platform \* \`on_hold\` - The order is paused from being processed. \* \`delivered\` - The order has been delivered to the customer. \* \`shipped\` - The order has moved from order management system to a shipping system. \* \`partially_delivered\` - The order has been partially delivered to the customer. \* \`returned\` - The order has been returned after delivery.
                          enum:
                          - new
                          - processing
                          - complete
                          - cancelled
                          - voided
                          - queued
                          - awaiting_shipment
                          - on_hold
                          - delivered
                          - shipped
                          - partially_delivered
                          - returned
                          pattern: "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\\
                            ]$"
                          example: null
                    price_type:
                      type: object
                      deprecated: false
                      description: |
                        The price type of the order
                      example: tax_exclusive
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.
                          enum:
                          - tax_exclusive
                          - tax_inclusive
                          pattern: "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\\
                            ]$"
                          example: null
                    order_date:
                      type: object
                      deprecated: false
                      description: |
                        The date on which the order will start getting processed.
                      example: "1394532759"
                      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
                    shipping_date:
                      type: object
                      deprecated: false
                      description: |
                        This is the date on which the order will be delivered to the customer.
                      example: "1394532759"
                      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
                    shipped_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the order was shipped.
                      example: "1394532759"
                      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
                    delivered_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the order was delivered
                      example: "1394532759"
                      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
                    cancelled_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the order was cancelled.
                      example: "1394532759"
                      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
                    amount_paid:
                      type: object
                      deprecated: false
                      description: |
                        Total amount paid for the order.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    refundable_credits:
                      type: object
                      deprecated: false
                      description: |
                        The total amount that can be issued as credits for this order.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    refundable_credits_issued:
                      type: object
                      deprecated: false
                      description: |
                        The total amount issued as credits on behalf of this order.
                      example: "1000"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter based on the time at which order has been updated.
                      example: "1243545465"
                      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
                    resent_status:
                      type: object
                      deprecated: false
                      description: |
                        Resent order status.
                      example: fully_resent
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
                          enum:
                          - fully_resent
                          - partially_resent
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
                          enum:
                          - fully_resent
                          - partially_resent
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
                          enum:
                          - fully_resent
                          - partially_resent
                          pattern: "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`fully_resent\` - Order is Fully resent \* \`partially_resent\` - Order is Partially resent
                          enum:
                          - fully_resent
                          - partially_resent
                          pattern: "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\\
                            ]$"
                          example: null
                    is_resent:
                      type: object
                      deprecated: false
                      description: |
                        Order is resent order or not.
                      example: "false"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    original_order_id:
                      type: object
                      deprecated: false
                      description: |
                        If resent order what is the parent order id.
                      example: "1243545465"
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                  example: null
              example: null
            encoding:
              order:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/addons:
    post:
      summary: Export Addons
      description: |
        This API triggers export of addon data. The exported zip file contains CSV files with addon-related data.
      operationId: export_addons
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The currency code (ISO 4217 format) of the addon. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*currency_code\\\[is\\\] = "USD"\*
                  example: USD
                  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
                addon:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for addon
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique ID for your system to identify the addon.
                      example: support_charge
                      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:
                      type: object
                      deprecated: false
                      description: |
                        The display name used in web interface for identifying the addon.
                      example: Support Charge
                      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
                    charge_type:
                      type: object
                      deprecated: false
                      description: |
                        Type of charge
                      example: recurring
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
                          enum:
                          - recurring
                          - non_recurring
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
                          enum:
                          - recurring
                          - non_recurring
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
                          enum:
                          - recurring
                          - non_recurring
                          pattern: "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`recurring\` - Charges are automatically applied in sync with the billing frequency of subscription. \* \`non_recurring\` - Charged immediately and only once every time it is applied.
                          enum:
                          - recurring
                          - non_recurring
                          pattern: "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\\
                            ]$"
                          example: null
                    price:
                      type: object
                      deprecated: false
                      description: |
                        Addon price is calculated based on the addon type and charge type. \[Learn more\](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing). The unit depends on the \[type of currency\](/docs/api/getting-started) .
                      example: "1300"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    period:
                      type: object
                      deprecated: false
                      description: |
                        Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
                      example: "3"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    period_unit:
                      type: object
                      deprecated: false
                      description: |
                        Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon
                      example: month
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
                          enum:
                          - day
                          - week
                          - month
                          - year
                          - not_applicable
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
                          enum:
                          - day
                          - week
                          - month
                          - year
                          - not_applicable
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
                          enum:
                          - day
                          - week
                          - month
                          - year
                          - not_applicable
                          pattern: "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`day\` - Charge based on Day(S) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s) \* \`not_applicable\` - not applicable for this addon
                          enum:
                          - day
                          - week
                          - month
                          - year
                          - not_applicable
                          pattern: "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\\
                            ]$"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Status of the addon
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`active\` - Only active addons can be applied to subscriptions \* \`archived\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \* \`deleted\` - Indicates the addon has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
              example: null
            encoding:
              addon:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/subscriptions:
    post:
      summary: Export Subscriptions
      description: |
        This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.
      operationId: export_subscriptions
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                export_type:
                  type: string
                  default: data
                  deprecated: false
                  description: |
                    Determines the format of the data. Returns the export type based on the selected value.
                    \* import_friendly_data -

                    Download import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html)
                    .
                    \* data -

                    Download your current data in CSV.
                  enum:
                  - data
                  - import_friendly_data
                  example: null
                cancel_reason_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \*\*Settings \\\> Configure Chargebee \\\> Reason Codes \\\> Subscriptions \\\> Subscription Cancellation\*\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*cancel_reason_code\\\[is\\\] = "Not Paid"\*
                  example: Not Paid
                  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
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                      example: 8gsnbYfsMLds
                      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
                    customer_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the customer with whom this subscription is associated.
                      example: 8gsnbYfsMLds
                      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
                    plan_id:
                      type: object
                      deprecated: false
                      description: |
                        Identifier of the plan for this subscription
                      example: basic
                      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
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Current state of the subscription
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.
                          enum:
                          - future
                          - in_trial
                          - active
                          - non_renewing
                          - paused
                          - cancelled
                          - transferred
                          pattern: "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\\
                            ]$"
                          example: null
                    cancel_reason:
                      type: object
                      deprecated: false
                      description: |
                        The reason for canceling the subscription. Set by Chargebee automatically.
                      example: not_paid
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer
                          enum:
                          - not_paid
                          - no_card
                          - fraud_review_failed
                          - non_compliant_eu_customer
                          - tax_calculation_failed
                          - currency_incompatible_with_gateway
                          - non_compliant_customer
                          pattern: "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\\
                            ]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    remaining_billing_cycles:
                      type: object
                      deprecated: false
                      description: |
                        \* When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. \* When the subscription is on a \[contract term\](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
                      example: "3"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        The time at which the subscription was created.
                      example: "1435054328"
                      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
                    activated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Time at which the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                        last changed to
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>.
                        For example, this value is updated when an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
                        or
                        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
                        subscription activates.</p>
                      example: "1435054328"
                      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
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    next_billing_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>
                        unless multiple subscription terms were invoiced in advance using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
                        parameter.</p>
                      example: "1435054328"
                      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
                    cancelled_at:
                      type: object
                      deprecated: false
                      description: |
                        Time at which subscription was cancelled or is set to be cancelled.
                      example: "1435054328"
                      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
                    has_scheduled_changes:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                        , there are subscription changes scheduled on next renewal.</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.
                        This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code>
                        input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>
                        for a faster response.</p>
                      example: "1243545465"
                      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
                    offline_payment_method:
                      type: object
                      deprecated: false
                      description: |
                        The preferred offline payment method for the subscription.
                      example: cash
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom
                          enum:
                          - no_preference
                          - cash
                          - check
                          - bank_transfer
                          - ach_credit
                          - sepa_credit
                          - boleto
                          - us_automated_bank_transfer
                          - eu_automated_bank_transfer
                          - uk_automated_bank_transfer
                          - jp_automated_bank_transfer
                          - mx_automated_bank_transfer
                          - custom
                          pattern: "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\\
                            ]$"
                          example: null
                    auto_close_invoices:
                      type: object
                      deprecated: false
                      description: |-
                        <p class="mb-2">Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        to override for this subscription, the <a href="https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a>
                        for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>
                        .</p>
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
              example: null
            encoding:
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /exports/plans:
    post:
      summary: Export Plans
      description: |
        This API triggers export of plan data. The exported zip file contains CSV files with plan-related data.
      operationId: export_plans
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter The currency code (ISO 4217 format) of the plan. \*\*Supported operators :\*\* is, is_not, starts_with, in, not_in \*\*Example →\*\* \*currency_code\\\[is\\\] = "USD"\*
                  example: USD
                  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
                plan:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for plan
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique ID for your system to identify the plan.
                      example: Enterprise
                      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:
                      type: object
                      deprecated: false
                      description: |
                        The display name used in web interface for identifying the plan.
                      example: plan_enterprise
                      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
                    price:
                      type: object
                      deprecated: false
                      description: |
                        The price of the plan. The unit depends on the \[type of currency\](/docs/api/getting-started) .
                      example: "1200"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    period:
                      type: object
                      deprecated: false
                      description: |
                        Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
                      example: "3"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                    period_unit:
                      type: object
                      deprecated: false
                      description: |
                        Defines billing frequency in association with billing period.
                      example: month
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
                          enum:
                          - day
                          - week
                          - month
                          - year
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
                          enum:
                          - day
                          - week
                          - month
                          - year
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
                          enum:
                          - day
                          - week
                          - month
                          - year
                          pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`day\` - Charge based on day(s) \* \`week\` - Charge based on week(s) \* \`month\` - Charge based on month(s) \* \`year\` - Charge based on year(s)
                          enum:
                          - day
                          - week
                          - month
                          - year
                          pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\\
                            ]$"
                          example: null
                    trial_period:
                      type: object
                      deprecated: false
                      description: |
                        The free time window for your customer to try your product
                      example: "14"
                      properties:
                        is:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        is_not:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        lte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gt:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        gte:
                          type: string
                          format: number
                          pattern: ^-?\d+$
                          example: null
                        between:
                          type: string
                          pattern: "^\\[-?\\d+,-?\\d+\\]$"
                          example: null
                        is_present:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    trial_period_unit:
                      type: object
                      deprecated: false
                      description: |
                        Time unit for the trial period.
                      example: day
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`day\` - In days \* \`month\` - In months
                          enum:
                          - day
                          - month
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`day\` - In days \* \`month\` - In months
                          enum:
                          - day
                          - month
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`day\` - In days \* \`month\` - In months
                          enum:
                          - day
                          - month
                          pattern: "^\\[(day|month)(,(day|month))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`day\` - In days \* \`month\` - In months
                          enum:
                          - day
                          - month
                          pattern: "^\\[(day|month)(,(day|month))*\\]$"
                          example: null
                    addon_applicability:
                      type: object
                      deprecated: false
                      description: |
                        Indicates if all or only some addons are applicable with the plan.
                      example: all
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
                          enum:
                          - all
                          - restricted
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
                          enum:
                          - all
                          - restricted
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
                          enum:
                          - all
                          - restricted
                          pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`all\` - All addons are applicable with this plan. \* \`restricted\` - Only addons marked as 'applicable_addons' are applicable with the plan.
                          enum:
                          - all
                          - restricted
                          pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
                          example: null
                    giftable:
                      type: object
                      deprecated: false
                      description: |
                        Specifies if the plan should be gifted or not.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        The plan state
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        is_not:
                          type: string
                          description: |
                            \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        in:
                          type: string
                          description: |
                            \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            \* \`active\` - New subscriptions can be created with the plan. \* \`archived\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \* \`deleted\` - Indicates the plan has been deleted.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
                      example: "1243545465"
                      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
                    channel:
                      type: object
                      deprecated: false
                      description: |
                        The subscription channel this object originated from and is maintained in.
                      example: APP STORE
                      properties:
                        is:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        is_not:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          example: null
                        in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "\\* \\`web\\` - The object was created (and\
                            \ is maintained) for the web channel directly in Chargebee\
                            \ via API or UI. \\* \\`app_store\\` - The object data\
                            \ is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Apple App Store. Direct manipulation of this\
                            \ object via UI or API is disallowed. \\* \\`play_store\\\
                            ` - The object data is synchronized with data from [in-app\
                            \ subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions)\
                            \ created in Google Play Store. Direct manipulation of\
                            \ this object via UI or API is disallowed.  \nIn-App Subscriptions\
                            \ is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\
                            \ for more information.\n"
                          enum:
                          - web
                          - app_store
                          - play_store
                          pattern: "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\\
                            ]$"
                          example: null
                  example: null
              example: null
            encoding:
              plan:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: <p class="mb-2">Resource object representing export</p>
                required:
                - export
                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: []
  /full_exports/status:
    get:
      summary: Retrieve full export status
      description: |
        This endpoint retrieves the status of your data export request.
      operationId: retrieve_full_export_status
      parameters:
      - name: table
        in: query
        description: |
          The name of the table for which the export status is to be retrieved. For example, invoices.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 200
          example: null
      - name: date
        in: query
        description: |
          The date for which the export status is required, formatted in YYYY-MM-DD format. For example, 2023-08-29.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          deprecated: false
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  full_export:
                    $ref: "#/components/schemas/FullExport"
                    description: <p class="mb-2">Resource object representing full_export</p>
                required:
                - full_export
                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: []
  /payment_intents/{payment-intent-id}:
    get:
      summary: Retrieve a payment intent
      description: |
        Retrieves the PaymentIntent resource.
      operationId: retrieve_a_payment_intent
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: payment-intent-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/payment-intent-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_intent:
                    $ref: "#/components/schemas/PaymentIntent"
                    description: <p class="mb-2">Resource object representing payment_intent</p>
                required:
                - payment_intent
                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: []
    post:
      summary: Update a payment intent
      description: |
        Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.
      operationId: update_a_payment_intent
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: payment-intent-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/payment-intent-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount(in cents) to be authorized for 3DS flow.
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the amount used in transaction.
                  maxLength: 3
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account used for performing the 3DS flow.
                  maxLength: 50
                  example: null
                payment_method_type:
                  type: string
                  default: card
                  deprecated: false
                  description: |
                    The payment method of this intent.
                    \* google_pay -

                    google_pay
                    \* pay_co -

                    Payments made via PayCo
                    \* boleto -

                    boleto
                    \* apple_pay -

                    apple_pay
                    \* cash_app_pay -

                    Payments made via Cash App Pay.
                    \* faster_payments -

                    Faster Payments
                    \* pix -

                    Pix
                    \* klarna_pay_now -

                    Klarna Pay Now
                    \* revolut_pay -

                    Payments made via Revolut Pay.
                    \* ideal -

                    ideal
                    \* naver_pay -

                    Payments made via Naver Pay.
                    \* amazon_payments -

                    Amazon Payments
                    \* bancontact -

                    bancontact
                    \* electronic_payment_standard -

                    Electronic Payment Standard
                    \* stablecoin -

                    Payments made via Stablecoin.
                    \* grab_pay -

                    Payments made via GrabPay
                    \* netbanking_emandates -

                    netbanking_emandates
                    \* pay_to -

                    PayTo
                    \* trustly -

                    Trustly
                    \* venmo -

                    Venmo
                    \* after_pay -

                    Payments made via Afterpay
                    \* alipay -

                    Payments made via Alipay.
                    \* card -

                    card
                    \* dotpay -

                    dotpay
                    \* giropay -

                    giropay
                    \* upi -

                    upi
                    \* sofort -

                    sofort
                    \* sepa_instant_transfer -

                    Sepa Instant Transfer
                    \* kakao_pay -

                    Payments made via Kakao Pay.
                    \* pay_by_bank -

                    Pay By Bank
                    \* go_pay -

                    Payments made via GoPay
                    \* swish -

                    Payments made via Swish
                    \* direct_debit -

                    direct_debit
                    \* payconiq_by_bancontact -

                    Payments made via Payconiq by Bancontact.
                    \* twint -

                    Payments made via Twint
                    \* payme -

                    Payments made via PayMe
                    \* wechat_pay -

                    Payments made via WeChat Pay.
                    \* paypal_express_checkout -

                    paypal_express_checkout
                    \* kbc_payment_button -

                    KBC Payment Button
                  enum:
                  - card
                  - ideal
                  - sofort
                  - bancontact
                  - google_pay
                  - dotpay
                  - giropay
                  - apple_pay
                  - upi
                  - netbanking_emandates
                  - paypal_express_checkout
                  - direct_debit
                  - boleto
                  - venmo
                  - amazon_payments
                  - pay_to
                  - faster_payments
                  - sepa_instant_transfer
                  - klarna_pay_now
                  - online_banking_poland
                  - payconiq_by_bancontact
                  - electronic_payment_standard
                  - kbc_payment_button
                  - pay_by_bank
                  - trustly
                  - stablecoin
                  - kakao_pay
                  - naver_pay
                  - revolut_pay
                  - cash_app_pay
                  - wechat_pay
                  - alipay
                  - twint
                  - go_pay
                  - grab_pay
                  - pay_co
                  - after_pay
                  - swish
                  - payme
                  - pix
                  - klarna
                  example: null
                success_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The URL the customer will be directed to once 3DS verification is successful. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
                    .</p>
                  maxLength: 250
                  example: null
                failure_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The URL the customer will be directed to when 3DS verification fails. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
                    .</p>
                  maxLength: 250
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_intent:
                    $ref: "#/components/schemas/PaymentIntent"
                    description: <p class="mb-2">Resource object representing payment_intent</p>
                required:
                - payment_intent
                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: []
  /payment_intents:
    post:
      summary: Create a payment intent
      description: "<div class=\"api-description\"><p class=\"mb-2\">Creates a PaymentIntent\
        \ object. This is to be used with Chargebee.js API to complete the 3DS flow\
        \ for new or stored cards.</p><p class=\"mb-2\">While creating, specify the\
        \ appropriate gateway account and amount. Exact amount can be estimated using\
        \ our <a href=\"/docs/api/estimates\">Estimate API</a>.</p><h4>Customer resource\
        \ lookup and creation</h4><p class=\"mb-2\">When <code><a href=\"/docs/api/payment_intents/create-a-payment-intent#customer_id\"\
        >customer[id]</a></code> is provided for this operation, it is looked up by\
        \ Chargebee, and if found, the payment_intent is created for it. If not found,\
        \ the <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">payment_intent</code>\
        \ is created without any customer association and will be available for any\
        \ customer.</p></div>"
      operationId: create_a_payment_intent
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The unique identifier of the customer for whom the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> will be created. If specified, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> will be used exclusively for that customer. If not specified, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> won&#x27;t be associated with any customer and will be available for any customer.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">See also</strong></p><p class="mb-2"><a href="/docs/api/payment_intents">Customer resource lookup and creation</a>
                    .</p></div>
                  maxLength: 50
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Amount(in cents) to be authorized for 3DS flow.
                  minimum: 0
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the amount used in transaction.
                  maxLength: 3
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: |
                    The gateway account used for performing the 3DS flow.
                  maxLength: 50
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: |
                    Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
                  maxLength: 200
                  example: null
                defer_payment_method_type:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                payment_method_type:
                  type: string
                  default: card
                  deprecated: false
                  description: |
                    The payment method of this intent.
                    \* google_pay -

                    google_pay
                    \* pay_co -

                    Payments made via PayCo
                    \* boleto -

                    boleto
                    \* apple_pay -

                    apple_pay
                    \* cash_app_pay -

                    Payments made via Cash App Pay.
                    \* faster_payments -

                    Faster Payments
                    \* pix -

                    Pix
                    \* klarna_pay_now -

                    Klarna Pay Now
                    \* revolut_pay -

                    Payments made via Revolut Pay.
                    \* ideal -

                    ideal
                    \* naver_pay -

                    Payments made via Naver Pay.
                    \* amazon_payments -

                    Amazon Payments
                    \* bancontact -

                    bancontact
                    \* electronic_payment_standard -

                    Electronic Payment Standard
                    \* stablecoin -

                    Payments made via Stablecoin.
                    \* grab_pay -

                    Payments made via GrabPay
                    \* netbanking_emandates -

                    netbanking_emandates
                    \* pay_to -

                    PayTo
                    \* trustly -

                    Trustly
                    \* venmo -

                    Venmo
                    \* after_pay -

                    Payments made via Afterpay
                    \* alipay -

                    Payments made via Alipay.
                    \* card -

                    card
                    \* dotpay -

                    dotpay
                    \* giropay -

                    giropay
                    \* upi -

                    upi
                    \* sofort -

                    sofort
                    \* sepa_instant_transfer -

                    Sepa Instant Transfer
                    \* kakao_pay -

                    Payments made via Kakao Pay.
                    \* pay_by_bank -

                    Pay By Bank
                    \* go_pay -

                    Payments made via GoPay
                    \* swish -

                    Payments made via Swish
                    \* direct_debit -

                    direct_debit
                    \* payconiq_by_bancontact -

                    Payments made via Payconiq by Bancontact.
                    \* twint -

                    Payments made via Twint
                    \* payme -

                    Payments made via PayMe
                    \* wechat_pay -

                    Payments made via WeChat Pay.
                    \* paypal_express_checkout -

                    paypal_express_checkout
                    \* kbc_payment_button -

                    KBC Payment Button
                  enum:
                  - card
                  - ideal
                  - sofort
                  - bancontact
                  - google_pay
                  - dotpay
                  - giropay
                  - apple_pay
                  - upi
                  - netbanking_emandates
                  - paypal_express_checkout
                  - direct_debit
                  - boleto
                  - venmo
                  - amazon_payments
                  - pay_to
                  - faster_payments
                  - sepa_instant_transfer
                  - klarna_pay_now
                  - online_banking_poland
                  - payconiq_by_bancontact
                  - electronic_payment_standard
                  - kbc_payment_button
                  - pay_by_bank
                  - trustly
                  - stablecoin
                  - kakao_pay
                  - naver_pay
                  - revolut_pay
                  - cash_app_pay
                  - wechat_pay
                  - alipay
                  - twint
                  - go_pay
                  - grab_pay
                  - pay_co
                  - after_pay
                  - swish
                  - payme
                  - pix
                  - klarna
                  example: null
                success_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The URL the customer will be directed to once 3DS verification is successful. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
                    .</p>
                  maxLength: 250
                  example: null
                failure_url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The URL the customer will be directed to when 3DS verification fails. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
                    , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
                    or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
                    .</p>
                  maxLength: 250
                  example: null
              required:
              - amount
              - currency_code
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_intent:
                    $ref: "#/components/schemas/PaymentIntent"
                    description: <p class="mb-2">Resource object representing payment_intent</p>
                required:
                - payment_intent
                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: []
  /custom_field_configs/retrieve:
    get:
      summary: Retrieve the meta data
      description: |
        Retrieves the configuration for the [custom field](/docs/api/advanced-features#custom-fields) that matches the specified entity type and API name.
      operationId: retrieve_the_meta_data
      parameters:
      - name: entity_type
        in: query
        description: |
          Allowed entity types for custom fields.
          \* customer -

          Entity that represents a customer.
          \* invoice -

          Entity that represents an invoice.
          \* addon_item -

          Entity that represents item of type addon.
          \* plan -

          Entity that represents a subscription plan.
          \* subscription -

          Entity that represents a subscription of a customer.
          \* charge_price -

          Entity that represents charge price.
          \* item_family -

          Entity that represents item family.
          \* addon -

          Entity that represents an addon.
          \* addon_price -

          Entity that represents addon price.
          \* credit_note -

          Entity that represents a credit note.
          \* charge_item -

          Entity that represents item of type charge.
          \* plan_item -

          Entity that represents item of type plan.
          \* plan_price -

          Entity that represents plan price.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - customer
          - subscription
          - plan
          - addon
          - invoice
          - credit_note
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - coupon
          - quote
          example: null
      - name: api_name
        in: query
        description: |
          Unique identifier for the custom field, used in API requests and responses.
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_field_config:
                    $ref: "#/components/schemas/CustomFieldConfig"
                    description: <p class="mb-2">Resource object representing custom_field_config.</p>
                required:
                - custom_field_config
                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: []
  /custom_field_configs:
    get:
      summary: List custom field configs
      description: |
        Lists the configurations for all [custom fields](/docs/api/advanced-features#custom-fields) defined for the specified entity type.
      operationId: list_custom_field_configs
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: entity_type
        in: query
        description: |
          Allowed entity types for custom fields.
          \* customer -

          Entity that represents a customer.
          \* invoice -

          Entity that represents an invoice.
          \* addon_item -

          Entity that represents item of type addon.
          \* plan -

          Entity that represents a subscription plan.
          \* subscription -

          Entity that represents a subscription of a customer.
          \* charge_price -

          Entity that represents charge price.
          \* item_family -

          Entity that represents item family.
          \* addon -

          Entity that represents an addon.
          \* addon_price -

          Entity that represents addon price.
          \* credit_note -

          Entity that represents a credit note.
          \* charge_item -

          Entity that represents item of type charge.
          \* plan_item -

          Entity that represents item of type plan.
          \* plan_price -

          Entity that represents plan price.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - customer
          - subscription
          - plan
          - addon
          - invoice
          - credit_note
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - coupon
          - quote
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        custom_field_config:
                          $ref: "#/components/schemas/CustomFieldConfig"
                          description: Resource object representing custom_field_config
                      required:
                      - custom_field_config
                      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: []
  /configurations:
    get:
      summary: List site configurations
      description: |
        Returns a list of your domain and product catalog version details.
      operationId: list_site_configurations
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurations:
                    type: array
                    description: <p class="mb-2">Resource object representing configuration</p>
                    items:
                      $ref: "#/components/schemas/Configuration"
                      description: Resource object representing configuration
                    example: null
                required:
                - configurations
                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: []
  /in_app_subscriptions/{in-app-subscription-app-id}/retrieve:
    post:
      summary: Retrieve Store Subscription
      description: |-
        <div class="api-description"><span featureId="cb-mobile-subscriptions"></span><p class="mb-2">This API verifies the application id <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">receipt</code> then returns the subscription details associated with the purchase.</p><h4>Path Parameter</h4><div class="cb-list cb-list-action "><div class="cb-list-item"><samp id="import_subscription_without_receipt_in_app_subscription_app_id"><p class="mb-2">in_app_subscription_app_id</p></samp></div><div class="cb-list-desc"><dfn class="text-muted"><p class="mb-2">required, string</p></dfn><p class="mb-2">The handle is created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.
        The following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">Apple App Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">View Keys</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#resource-id" target="_blank">here</a>.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">Google Play Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">Set up notifications</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id" target="_blank">here</a>.</li>
        </ul></div></div></div>
      operationId: retrieve_store_subscription
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: in-app-subscription-app-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/in-app-subscription-app-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                receipt:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The Base64 encoded <a href="https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview" target="_blank">App Store in-app purchase receipt</a> taken from the Apple device after successful creation of the in-app purchase subscription.
                    <strong class="font-semibold">Google Play Store</strong>: The purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> taken from the Android device after the successful creation of an in-app purchase subscription.</p>
                  maxLength: 65000
                  example: null
              required:
              - receipt
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  in_app_subscriptions:
                    type: array
                    description: <p class="mb-2">Array of in_app_subscription object</p>
                    items:
                      $ref: "#/components/schemas/InAppSubscription"
                      description: Resource object representing in_app_subscription
                    example: null
                required:
                - in_app_subscriptions
                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: []
  /in_app_subscriptions/{in-app-subscription-app-id}/import_receipt:
    post:
      summary: Import Receipt
      description: |-
        <div class="api-description"><span featureId="cb-mobile-subscriptions"></span><p class="mb-2">Verifies an Apple App Store or Google Play Store in-app purchase <a href="https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview">receipt</a> and imports <a href="/docs/api/subscriptions">subscriptions</a> for all historical purchases made by the customer.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</strong>
        An <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_app_subscription</code>
        is created for every unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
        . Apple creates <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
        for every create, upgrade, or downgrade of the subscription. A receipt hardly contains more than 100 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
        s. If a receipt contains more than 100 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
        s, Chargebee creates all subscription records but this endpoint returns the first 100 records in the response.</p></div><p class="mb-2">CSV upload has a file size <code><a href="https://www.chargebee.com/docs/mobile-app-store-product-iap.html#upload-in-app-receipts">limitation</a></code> that increases the processing time and the number of receipts. This API removes such limitations and allows you to import historical in-app subscription receipts.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong>
        : This API verifies receipt or token through Apple or Google and then processes them via Chargebee. For bulk imports, limit API calls to <strong class="font-semibold">6</strong>
        per minute (<strong class="font-semibold">10</strong>
        seconds apart) to ensure successful subscription imports.</p></div><div id="apple-app-store-accordion" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#apple-app-store-accordion-content" aria-expanded="false" aria-controls="apple-app-store-accordion-content">Apple App Store<i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="apple-app-store-accordion-content"><p class="mb-2">This section provides details of the Import Receipt operation performed for the Apple App Store. This API processes only the historical in-app transaction receipts.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site" target="_blank">Integrate Chargebee</a> with your Apple App Store account using your shared secret from Apple.</li>
        <li class="text-base leading-relaxed">It is strongly recommended to use this endpoint to import historical in-app subscriptions only.</li>
        <li class="text-base leading-relaxed">You must <a href="https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#import-products" target="_blank">import Apple App Store products</a> using Chargebee&#x27;s user interface before importing receipts using this API.</li>
        </ul></div><p class="mb-2">Chargebee validates the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">receipt</code> with Apple App Store and does the following once validation succeeds:</p><h4>Subscriptions</h4><p class="mb-2"><a href="/docs/api/subscriptions">Subscriptions</a> are imported as follows:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">A subscription is imported for every unique value of the <code><a href="https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc">original_transaction_id</a></code> in the Apple receipt.
        <strong class="font-semibold">Note</strong>: This is not done for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>s for which a subscription already exists in Chargebee.</li>
        <li class="text-base leading-relaxed">Each subscription imported has the following attributes set:
        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> set to the earliest <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc">purchase_date_ms</a></code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code> set to latest <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc">purchase_date_ms</a></code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> set to <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc">expires_date_ms</a></code> of the same <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Latest_receipt_info</code> element with the latest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">purchase_date_ms</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product_id</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> if there is only one element of <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc">Latest_receipt_info</a></code> with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code> and the field <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">is_trial_period</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, then consider the subscription is currently in trial. No invoices are created for this subscription.</li>
        </ul>
        </li>
        </ol><h4>Invoices for the subscription</h4><p class="mb-2"><a href="/docs/api/invoices">Invoices</a> are imported as follows:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">An invoice is imported to Chargebee for every element of the array <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc">Latest_receipt_info</a></code> which has <code><a href="https://developer.apple.com/documentation/appstorereceipts/is_trial_period?language=objc">is_trial_period</a></code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>.</li>
        <li class="text-base leading-relaxed">Each imported invoice has the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>.</li>
        </ol><h4>Transactions for the invoices</h4><p class="mb-2">A <a href="/docs/api/transactions">transaction</a> is imported for each invoice with the following details:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">reference_number</code> set to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction_id</code>.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apple_store</code>.</li>
        </ol></div></div><div id="google-play-store-accordion" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#google-play-store-accordion-content" aria-expanded="false" aria-controls="google-play-store-accordion-content">Google Play Store<i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="google-play-store-accordion-content"><p class="mb-2">This section provides details of the Import Receipt operation performed for the Google Play Store. This API is used to process only the historical in-app purchase subscriptions.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/mobile-playstore-connect.html">Integrate Chargebee</a> with your Google Play Store account using your <a href="https://www.chargebee.com/docs/2.0/mobile-playstore-connect.html#generate-service-account-credentials-json">service account credentials JSON</a>.</li>
        <li class="text-base leading-relaxed">It is strongly recommended to use this endpoint to import historical in-app subscriptions only.</li>
        <li class="text-base leading-relaxed">It is recommended to pass only the latest purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code>. If any other purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> is passed instead of the latest one, there is a possibility of returning incorrect transaction details. If an expired purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> is passed, then it returns an error.</li>
        <li class="text-base leading-relaxed">The Google purchase token is <a href="https://developer.android.com/google/play/billing/lifecycle/subscriptions" target="_blank" rel="noopener noreferrer">valid from subscription signup until 60 days</a> after subscription expiration. After the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> expires, an API request to Google Developers API returns an error.</li>
        </ul></div><p class="mb-2">Chargebee validates the purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> with Google Play Store and does the following once validation succeeds:</p><h4>Subscriptions</h4><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">A <a href="/docs/api/subscriptions">subscription</a> is imported for every unique purchase token if it is not linked to an existing purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code>( <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linkedPurchaseToken</code> field in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionsV2.get</code> API Response).</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Each subscription imported has the following attributes set:</p>
        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> set to a unique identifier generated by Chargebee and mapped to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latestOrderId</code> of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchaseV2</code> object from Google response.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> set to the earliest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchaseV2.startTime</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code> set to latest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchaseV2.startTime</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expiryTime</code> of the same <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchaseV2</code> element with the latest purchase.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_id</code> set to the concatenation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">priceCurrencyCode</code> from Google.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> if the free trial configuration is enabled in Google and the <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#State">monetization.subscriptions.basePlans.offers.State</a></code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Active</code> with a <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#subscriptionofferphase">SubscriptionOfferPhase.duration</a></code>, then consider the subscription is currently in trial. No invoices are created for this subscription.</p>
        </li>
        </ul>
        </li>
        </ul><h4>Invoices for the subscription</h4><p class="mb-2">Invoices are imported as follows:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">An <a href="/docs/api/invoices">invoice</a> is imported to Chargebee for every new subscription and renewal of an existing subscription using <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latestOrderId</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Each imported invoice has the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> set to a unique identifier generated by Chargebee and mapped to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latestOrderId</code>.</p>
        </li>
        </ul><h4>Transactions for the invoices</h4><p class="mb-2">A <a href="/docs/api/transactions">transaction</a> is imported for each invoice with the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction.reference_number</code> is set to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latestOrderId</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction.payment_method</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">play_store</code>.</p>
        </li>
        </ul></div></div><h2>Path Parameter</h2><p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>: The handle created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.
        The following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">Apple App Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">View Keys</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#connection-keys_app-id" target="_blank">here</a>.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">Google Play Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">Set up notifications</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id" target="_blank">here</a>.</li>
        </ul></div>
      operationId: import_receipt
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: in-app-subscription-app-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/in-app-subscription-app-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                receipt:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The Base64 encoded <a href="https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview" target="_blank">App Store in-app purchase receipt</a> taken from the Apple device after successful creation of the in-app purchase subscription.
                    <strong class="font-semibold">Google Play Store</strong>: The purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> taken from the Android device after the successful creation of an in-app purchase subscription.</p>
                  maxLength: 65000
                  example: null
                product:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for product
                  properties:
                    currency_code:
                      type: string
                      deprecated: false
                      description: |
                        **Apple App Store** : The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) for the product.
                        **Google Play Store** : This parameter is **not applicable** to the Google Play Store. If the value is passed, it will return a validation error.
                      maxLength: 3
                      example: null
                  required:
                  - currency_code
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> in Chargebee for the customer who made this purchase. If not provided, the value is considered to be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code> (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
                        <strong class="font-semibold">Google Play Store</strong>: The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> of the customer who made this purchase via Google Play Store. This unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> will be used as customer ID within Chargebee. If not provided, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> (random unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>) will be the customer ID. If the customer ID already exists in Chargebee then subscription will be associated with this customer ID.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        **Apple App Store** : The email ID of the customer who made this purchase.
                        **Google Play Store**: The email ID of the customer who made this purchase.
                      maxLength: 70
                      example: null
                  example: null
              required:
              - receipt
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              product:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  in_app_subscriptions:
                    type: array
                    description: <p class="mb-2">Array of in_app_subscription object</p>
                    items:
                      $ref: "#/components/schemas/InAppSubscription"
                      description: Resource object representing in_app_subscription
                    example: null
                required:
                - in_app_subscriptions
                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: []
  /in_app_subscriptions/{in-app-subscription-app-id}/import_subscription:
    post:
      summary: Import Subscription Without Receipt
      description: |-
        <div class="api-description"><span featureId="cb-mobile-subscriptions"></span><p class="mb-2">The Import Subscriptions endpoint is a Chargebee API that allows you to import historic In-App Subscriptions without using a valid Apple App Store receipt. This endpoint is useful if you do not have access to the receipt data which is required for the <a href="/docs/api/in_app_subscriptions/import-receipt">Import Receipt</a> API.
        With this API, you can import subscriptions and corresponding invoices for historic In-App purchases. The API returns the <a href="/docs/api/in_app_subscriptions/in-app-subscription-object">in-app-subscriptions object</a> once the historic subscription is successfully imported into Chargebee.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Subscriptions cannot be imported from the Google Play Store without a receipt or token. Therefore; Chargebee does not allow you to use this API for the Google Play Store.</li>
        <li class="text-base leading-relaxed">Enable V1 notifications in the Apple App Store for subscriptions created without receipts. Chargebee depends on receipt data to update subscription statuses. Apple&#x27;s V2 notifications do not have receipt information; therefore, Chargebee cannot process V2 notifications for subscriptions imported without receipts. Learn more about <a href="/docs/api/in_app_purchase_events">app store notifications</a> and <a href="https://www.chargebee.com/docs/mobile-app-store-product-iap.html#connection-keys_notification-url">notification URL configuration</a>.</li>
        </ul></div><h3>Apple App Store</h3><p class="mb-2">This section provides details of the Import Subscription operation when performed for the Apple App Store. This API creates a historic subscription if the incoming subscription is unknown. For a known subscription, it creates an invoice for the mentioned period.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><a href="https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site" target="_blank" rel="noopener noreferrer">Integrate Chargebee</a> with your Apple App Store account using your shared secret from Apple.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">It is strongly recommended to use this endpoint to create a historic In-App subscription only.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">You must import App Store products using Chargebee&#x27;s user interface before importing receipts using this API.</p>
        </li>
        </ul></div><p class="mb-2">Chargebee validates the application ID with Apple App Store and does the following once validation succeeds:</p><h4>Subscription</h4><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">Import the subscription from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latest_receipt_info</code> array from Apple, and a new subscription is imported for the item-price.
        <strong class="font-semibold">Note:</strong> The subscription is not imported if it already exists in Chargebee but we will import the associated invoice using the subscription[transaction_id] in the payload.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Each subscription imported has the following attribute set:</p>
        <ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code> . This <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[id]</code> is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code> in the receipts.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[start_date]</code>. You need to provide this information from the oldest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Latest_receipt_info.purchase_date_ms</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">term_start</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[term_start]</code>. You need to provide this information from the oldest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Latest_receipt_info.purchase_date_ms)</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">term_end</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[term_end]</code>. You need to provide this information from the oldest <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Latest_receipt_info.expires_date_ms</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription[product_id] + subscription[currency_code].</code> You need to provide this information from the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Latest_receipt_info.product_id</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Chargebee records the subscription in a <strong class="font-semibold">Trial</strong> state if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">is_trial_period</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Chargebee records the subscription in a <strong class="font-semibold">Canceled</strong> state if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">term_end</code> is less than the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">System.currentTime()</code>.</p>
        </li>
        </ul>
        </li>
        </ol><h4>Invoice for the subscription</h4><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The payment is recorded against the subscription invoice.</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Imported invoice has the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>.</li>
        </ul><h4>Transactions for the invoice</h4><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The associated transaction is updated with the following details:</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction.reference_number</code> is set to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction_id</code> of the payment.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transaction.payment_method</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apple_store</code>.</p>
        </li>
        </ul><h4>Path Parameter</h4><div class="cb-list cb-list-action "><div class="cb-list-item"><samp id="import_subscription_without_receipt_in_app_subscription_app_id"><p class="mb-2">in_app_subscription_app_id</p></samp></div><div class="cb-list-desc"><dfn class="text-muted"><p class="mb-2">required, string</p></dfn><p class="mb-2">The handle created by Chargebee for your App Store app. It can be obtained from within the Chargebee web app. To obtain the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_app_subscription_app_id</code> for the Apple App Store, click <strong class="font-semibold">View Keys</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app, and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/mobile-app-store-product-iap.html#connection-keys_app-id" target="_blank" rel="noopener noreferrer">here</a>.</p></div></div></div>
      operationId: import_subscription_without_receipt
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: in-app-subscription-app-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/in-app-subscription-app-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: <p class="mb-2">This parameter is known as <code
                        class="bg-gray-100 text-gray-800 font-medium border border-gray-300
                        rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
                        in Apple App Store. You can get the value of <code class="bg-gray-100
                        text-gray-800 font-medium border border-gray-300 rounded px-1.5
                        py-0.5 mx-1 text-sm font-mono whitespace-nowrap">original_transaction_id</code>
                        from the <a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info"
                        target="_blank" rel="noopener noreferrer"><code class="bg-gray-100
                        text-gray-800 font-medium border border-gray-300 rounded px-1.5
                        py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latest_receipt_info</code></a>.
                        The <code class="bg-gray-100 text-gray-800 font-medium border
                        border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono
                        whitespace-nowrap">latest_receipt_info</code> is an array
                        that contains all in-app purchase transactions.</p>
                      maxLength: 50
                      example: null
                    started_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: <p class="mb-2">The time at which the subscription
                        has started or going to be started. You can find this value
                        from the oldest <code class="bg-gray-100 text-gray-800 font-medium
                        border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm
                        font-mono whitespace-nowrap">purchase_date_ms</code>.</p>
                      example: null
                    term_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: <p class="mb-2">Start date of the billing period
                        for the subscription. You can find it from the <code class="bg-gray-100
                        text-gray-800 font-medium border border-gray-300 rounded px-1.5
                        py-0.5 mx-1 text-sm font-mono whitespace-nowrap">purchase_date_ms</code>
                        field in receipt payload.</p>
                      example: null
                    term_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: <p class="mb-2">End date of the billing period
                        for the subscription. You can find it from the <code class="bg-gray-100
                        text-gray-800 font-medium border border-gray-300 rounded px-1.5
                        py-0.5 mx-1 text-sm font-mono whitespace-nowrap">expires_date_ms</code>
                        field in receipt payload.</p>
                      example: null
                    product_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique identifier of the product as configured in App Store Connect.
                      maxLength: 96
                      example: null
                    currency_code:
                      type: string
                      deprecated: false
                      description: |
                        The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
                        ) for the product.
                      maxLength: 3
                      example: null
                    transaction_id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">Transaction ID value as mentioned in the <a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info" target="_blank" rel="noopener noreferrer"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">latest_receipt_info</code></a>.
                        This must be unique across subscriptions.</p>
                      maxLength: 43
                      example: null
                    is_trial:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |-
                        <p class="mb-2">Indicates if the subscription is in trial for the term start and term end. The default value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                        .</p>
                      example: null
                  required:
                  - currency_code
                  - id
                  - product_id
                  - started_at
                  - term_end
                  - term_start
                  - transaction_id
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "<p class=\"mb-2\">The unique <code><a href=\"\
                        /docs/api/customers/create-a-customer#id\">id</a></code> in\
                        \ Chargebee for the customer who made this purchase. If not\
                        \ provided, the value is considered to be <code><a href=\"\
                        https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc\"\
                        \ target=\"_blank\">original_transaction_id</a></code> (the\
                        \ transaction identifier at Apple, of the original purchase.).\
                        \ If the customer record is not found in Chargebee, it is\
                        \ created.</p>"
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email ID of the customer who made this purchase.
                      maxLength: 70
                      example: null
                  example: null
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  in_app_subscription:
                    $ref: "#/components/schemas/InAppSubscription"
                    description: <p class="mb-2">Resource object representing in_app_subscription</p>
                required:
                - in_app_subscription
                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: []
  /in_app_subscriptions/{in-app-subscription-app-id}/process_purchase_command:
    post:
      summary: Process Purchase Command
      description: |-
        <div class="api-description"><span featureId="cb-mobile-subscriptions"></span><p class="mb-2">Verifies an in-app purchase made by your customer and creates a subscription in Chargebee.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        If App Store or Play Store products have not been imported to Chargebee and this API is invoked, Chargebee will automatically create plans that correspond to the store product IDs. However, if historical subscriptions are to be imported using the <a href="/docs/api/v2/pcv-1/in_app_subscriptions/import-receipt">import receipt</a> API, importing products is mandatory. <a href="https://www.chargebee.com/docs/1.0/mobile_subscriptions.html">Learn more</a>.</p></div><div id="apple-app-store-accordion" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#apple-app-store-accordion-content" aria-expanded="false" aria-controls="apple-app-store-accordion-content">Apple App Store<i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="apple-app-store-accordion-content"><p class="mb-2">This section provides details of the Process Purchase Command operation when performed for the Apple App Store. This API processes only the latest in-app transaction on the receipt. Sync historical subscriptions into Chargebee using <a href="https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#import-in-app-purchase-receipts" target="_blank">bulk import</a> of In-App Purchase receipts.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site" target="_blank">Integrate Chargebee</a> with your Apple App Store account using your shared secret from Apple.</li>
        <li class="text-base leading-relaxed">It is strongly recommended to use this endpoint to notify Chargebee of <strong class="font-semibold">new</strong> purchases only.</li>
        <li class="text-base leading-relaxed">For updates to existing subscriptions, we recommend that you configure Apple App Store to send server notifications to Chargebee.</li>
        </ul></div><p class="mb-2">Chargebee validates the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">receipt</code> with Apple App Store and does the following once validation succeeds:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Look for <code><a href="/docs/api/v2/pcv-1/plans/plan-object#id">plan_id</a></code> that matches the concatenation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">priceCurrencyCode</code> from Apple, and if not found, create such a plan.</li>
        <li class="text-base leading-relaxed">Create/update a subscription:</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> set to <code><a href="https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc" target="_blank">original_transaction_id</a></code></p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> set to <code><a href="https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc" target="_blank">responseBody.Latest_receipt_info.purchase_date_ms</a></code></p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">responseBody.Latest_receipt_info.expires_date_ms</code></p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Instead, if the receipt belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Apple.</p>
        </li>
        </ul><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The payment is recorded against the subscription invoice. The associated transaction is updated with the following details:</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The <code><a href="/docs/api/transactions/transaction-object#reference_number">transaction.reference_number</a></code> is set to the <code><a href="https://developer.apple.com/documentation/appstorereceipts/transaction_id?language=objc" target="_blank">transaction_id</a></code> of the payment.</li>
        <li class="text-base leading-relaxed">The <code><a href="/docs/api/transactions/transaction-object#payment_method" target="_blank">transaction.payment_method</a></code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apple_pay</code>.</li>
        </ul></div></div><div id="google-play-store-accordion" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#google-play-store-accordion-content" aria-expanded="false" aria-controls="google-play-store-accordion-content">Google Play Store<i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="google-play-store-accordion-content"><p class="mb-2">This section provides details of the Process Purchase Command operation when performed for the Google Play Store. This API processes only the latest in-app transaction using the purchase token.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/mobile-playstore-connect.html#chargebee-configuration" target="_blank">Integrate Chargebee</a> with your Google Play Store account using the service account credentials JSON.</li>
        <li class="text-base leading-relaxed">It is strongly recommended to use this endpoint to notify Chargebee of <strong class="font-semibold">new</strong> purchases only.</li>
        <li class="text-base leading-relaxed">For updates to existing subscriptions, we recommend that you configure Chargebee to receive Google&#x27;s server notifications through pub/sub topic. <a href="https://developer.android.com/google/play/billing/getting-ready#setup-pubsub" target="_blank">Learn more</a>.</li>
        </ul></div><p class="mb-2">Chargebee validates the <strong class="font-semibold">token</strong> with Google Play Store and does the following once validation succeeds:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Look for <code><a href="/docs/api/v2/pcv-1/plans/plan-object#id">plan_id</a></code> that matches the concatenation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code> and <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en#SubscriptionPurchase.FIELDS.price_currency_code" target="_blank">priceCurrencyCode</a></code> from Google, and if not found, create such a plan.</li>
        <li class="text-base leading-relaxed">Create/update a subscription:</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> set to set to unique identifier generated by Chargebee and mapped to <strong class="font-semibold">token</strong> of the <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en" target="_blank">SubscriptionPurchase</a></code> object from Google response.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchase.startTimeMillis</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SubscriptionPurchase.expiryTimeMillis</code>.</p>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Instead, if the token belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Google.</p>
        </li>
        </ul><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The payment is recorded against the subscription invoice. The associated transaction is updated with the following details:</li>
        </ol><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#reference_number">transaction.reference_number</a></code> is set to the <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en#SubscriptionPurchase.FIELDS.order_id" target="_blank">orderId</a></code> of the payment.</li>
        <li class="text-base leading-relaxed">The <code><a href="/docs/api/v2/pcv-1/transactions/transaction-object#payment_method">transaction.payment_method</a></code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">play_store</code>.</li>
        </ul></div></div><h2>Path Parameter</h2><p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>: The handle created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.
        The following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">Apple App Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">View Keys</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#connection-keys_app-id" target="_blank">here</a>.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">Google Play Store</strong>: To obtain the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{in_app_subscription_app_id}</code>, click <strong class="font-semibold">Set up notifications</strong> within the <strong class="font-semibold">Sync Overview</strong> page of the web app and use the value of generated <strong class="font-semibold">App ID</strong> for this parameter. See detailed steps <a href="https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id" target="_blank">here</a>.</li>
        </ul></div>
      operationId: process_purchase_command
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: in-app-subscription-app-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/in-app-subscription-app-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                receipt:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The Base64 encoded <a href="https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview" target="_blank">App Store in-app purchase receipt</a> taken from the Apple device after successful creation of the in-app purchase subscription.
                    <strong class="font-semibold">Google Play Store</strong>: The purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code> taken from the Android device after the successful creation of an in-app purchase subscription.</p>
                  maxLength: 65000
                  example: null
                product:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for product
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        The unique identifier of the product purchased. The value of this parameter is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productId</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscriptionId</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sku</code>
                        received from the <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/inappproducts/get" target="_blank">Google Play Store</a></code>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                        The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">max chars</code>
                        limit is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">95</code>
                        for Google Play Store.</p></div>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The <a href="https://developer.apple.com/documentation/storekit/product/id/" target="_blank">unique identifier</a>
                        (created in <a href="https://appstoreconnect.apple.com/login" target="_blank">App Store Connect</a>
                        ) of the product purchased.</p>
                      maxLength: 96
                      example: null
                    currency_code:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** :
                        This parameter is **not applicable**
                        to the Google Play Store. If the value is passed, it will return a validation error.

                        **Apple App Store**:
                        The currency code (ISO 4217 format) for the product.
                      maxLength: 3
                      example: null
                    price:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong> to the Google Play Store. If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The price paid by the customer for this product. The unit <a href="/docs/api/getting-started">depends on the type of currency</a>. Provide either this or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price_in_decimal]</code>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                        <li class="text-base leading-relaxed">When the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price]</code> is passed through this API then it will override the product price configured in Chargebee while creating a subscription.</li>
                        <li class="text-base leading-relaxed">When no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price]</code> is passed and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code> does not exist in Chargebee then this API will return an error.</li>
                        <li class="text-base leading-relaxed">During the reactivation of a subscription, the old price of the subscription will be considered irrespective of the value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price]</code> passed through this API.</li>
                        </ul></div>
                      minimum: 0
                      example: null
                    name:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        The name (created in <a href="https://play.google.com/console/about/" target="_blank" rel="noopener noreferrer">Play Store Console</a>
                        ) of the product purchased. If not passed then the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code>
                        will be considered as the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[name]</code>
                        .</p>
                        <dfn class="text-muted"><p class="mb-2">optional, string, max chars=46</p></dfn>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The name (created in <a href="https://appstoreconnect.apple.com/login" target="_blank" rel="noopener noreferrer">App Store Connect</a>
                        ) of the product purchased.</p>
                      maxLength: 46
                      example: null
                    price_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong>
                        to the Google Play Store. If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price]</code>
                        .</p>
                      maxLength: 39
                      example: null
                    period:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong>
                        to the Google Play Store. If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        This is the renewal period of the subscription. For example, 1, 2, 3, and so on. This is an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">optional</code>
                        parameter. The parameter value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">required</code>
                        if the product(s) are not imported to Chargebee from Apple App Store.</p>
                      maxLength: 3
                      example: null
                    period_unit:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong>
                        to the Google Play Store. If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        This is the unit of the renewal period. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                        represents the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">day</code>
                        ,<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">1</code>
                        represents the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">week</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">2</code>
                        represents the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">month</code>
                        , and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">3</code>
                        represents the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">year</code>.
                        This is an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">optional</code>
                        parameter. The parameter value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">required</code>
                        if the product(s) are not imported to Chargebee from Apple App Store.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                        Since the Apple App Store receipt does not have the subscription renewal period information for trial subscriptions, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[period]</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[period_unit]</code> are needed, to create a subscription in Chargebee with the trial period. If these parameters are not passed and the receipt has trial information then Chargebee will return a validation error.</p></div>
                      maxLength: 3
                      example: null
                  required:
                  - currency_code
                  - id
                  - price
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        The unique <code><a href="/docs/api/customers/create-a-customer#id">id</a></code>
                        in Chargebee for the customer who made this purchase via Google Play Store. If not provided, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code>
                        (random unique id) will be the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer[id]</code>.
                        If the customer record is not found in Chargebee, it is created.</p>
                        <dfn class="text-muted"><p class="mb-2">optional, string, max chars=50</p></dfn>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The unique <code><a href="/docs/api/customers/create-a-customer#id">id</a></code>
                        in Chargebee for the customer who made this purchase. If not provided, the value is considered to be <code><a href="https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc" target="_blank">original_transaction_id</a></code>
                        (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address of the customer who made the purchase.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the customer who made the purchase.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the customer who made the purchase.
                      maxLength: 150
                      example: null
                  example: null
              required:
              - receipt
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              product:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  in_app_subscription:
                    $ref: "#/components/schemas/InAppSubscription"
                    description: <p class="mb-2">Resource object representing in_app_subscription</p>
                required:
                - in_app_subscription
                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: []
  /non_subscriptions/{non-subscription-app-id}/one_time_purchase:
    post:
      summary: One time purchase
      description: |
        This API is used to sync consumable, non-consumable, and non-renewing product payments in Chargebee.
      operationId: one_time_purchase
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: non-subscription-app-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/non-subscription-app-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                receipt:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                    The purchase <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">token</code>
                    taken from the Android device after successful creation of the in-app purchase.</p>
                    <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                    The Base64 encoded <a href="https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview" target="_blank">App Store in-app purchase receipt</a>
                    taken from the Apple device after successful creation of the in-app purchase.</p>
                  maxLength: 65000
                  example: null
                product:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for product
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>: The unique identifier of the product purchased. The value of this parameter is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productId</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sku</code> received from the <code><a href="https://developers.google.com/android-publisher/api-ref/rest/v3/inappproducts/get" target="_blank">Google Play Store</a></code>.</p>
                        <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
                        The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">max chars</code>
                        limit is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">95</code>
                        for the Google Play Store.</p></div>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The <a href="https://developer.apple.com/documentation/storekit/product/id/" target="_blank">unique identifier</a> (created in <a href="https://appstoreconnect.apple.com/login" target="_blank">App Store Connect</a>) of the product purchased.</p>
                      maxLength: 96
                      example: null
                    currency_code:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** :
                        This parameter is **not applicable**
                        to the **Google Play Store**.
                        If the value is passed, it will return a validation error.

                        **Apple App Store**:
                        The currency code (ISO 4217 format) for the product.
                      maxLength: 3
                      example: null
                    price:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong>
                        to the <strong class="font-semibold">Google Play Store</strong>.
                        If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The price paid by the customer for this product. The unit <a href="/docs/api/getting-started">depends on the type of currency</a>.
                        Provide either this or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price_in_decimal]</code>
                        .</p>
                      minimum: 0
                      example: null
                    type:
                      type: string
                      deprecated: false
                      description: |
                        The type of product for one time purchase.
                        \* consumable -

                        This value represents a type of one-time purchase that provides users with in-app benefits or effects that can be consumed or depleted over time, such as lives, gems, boosts, or digital tips. Once consumed, the purchased item is no longer available and must be repurchased to obtain its benefits again.
                        \* non_consumable -

                        The value represents a type of in-app purchase that provides a permanent benefit to the user and can be purchased once without expiration. This type of purchase is typically used to offer premium features or content that enhance the user experience of the app, such as additional filters or cosmetic items in a game.
                        \* non_renewing_subscription -

                        The value represents a type of subscription that grants access to services or content for a limited period of time, such as a season pass to in-game content. Unlike other subscription models, this type of subscription does not renew automatically and requires people to purchase a new subscription once it concludes to continue accessing the content or services.
                      enum:
                      - consumable
                      - non_consumable
                      - non_renewing_subscription
                      example: null
                    name:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        The name (created in <a href="https://play.google.com/console/about/" target="_blank" rel="noopener noreferrer">Play Store Console</a>
                        ) of the product purchased. If not passed then the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[id]</code>
                        will be considered as the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[name]</code>.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The name (created in <a href="https://appstoreconnect.apple.com/login" target="_blank" rel="noopener noreferrer">App Store Connect</a>
                        ) of the product purchased.</p>
                      maxLength: 96
                      example: null
                    price_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        This parameter is <strong class="font-semibold">not applicable</strong> to the <strong class="font-semibold">Google Play Store</strong>. If the value is passed, it will return a validation error.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>: The price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">product[price]</code>.</p>
                      maxLength: 39
                      example: null
                  required:
                  - currency_code
                  - id
                  - price
                  - type
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2"><strong class="font-semibold">Google Play Store</strong>:
                        The unique <code><a href="/docs/api/customers/create-a-customer#id">id</a></code>
                        in Chargebee for the customer who made this purchase via Google Play Store. If not provided, a random unique ID generated for the purchase token will be the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer[id]</code>.
                        If the customer record is not found in Chargebee, it is created.</p>
                        <p class="mb-2"><strong class="font-semibold">Apple App Store</strong>:
                        The unique <code><a href="/docs/api/customers/create-a-customer#id">id</a></code>
                        in Chargebee for the customer who made this purchase. If not provided, the value is considered to be <code><a href="https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc" target="_blank">original_transaction_id</a></code>
                        (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.</p>
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address of the customer who made the purchase.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        The first name of the customer who made the purchase.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        The last name of the customer who made the purchase.
                      maxLength: 150
                      example: null
                  example: null
              required:
              - receipt
              example: null
            encoding:
              customer:
                style: deepObject
                explode: true
              product:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  non_subscription:
                    $ref: "#/components/schemas/NonSubscription"
                    description: <p class="mb-2">Resource object representing non_subscription</p>
                required:
                - non_subscription
                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: []
  /customers/{customer-id}/payment_vouchers:
    get:
      summary: List vouchers for a customer
      description: |
        Retrieves vouchers for a customer in reverse chronological order.
      operationId: list_vouchers_for_a_customer
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: customer-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/customer-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Current status of Payment Voucher. Possible values are : active, consumed, expired, failure.

          **Supported operators :**
          is, is_not, in, not_in, in, not_in

          **Example →**
          *status\[is\] = "active, consumed, expired"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "active, consumed, expired"
          properties:
            is:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              example: null
            is_not:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              example: null
            in:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              pattern: "^\\[(active|consumed|expired|failure)(,(active|consumed|expired|failure))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              pattern: "^\\[(active|consumed|expired|failure)(,(active|consumed|expired|failure))*\\\
                ]$"
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - date
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        payment_voucher:
                          $ref: "#/components/schemas/PaymentVoucher"
                          description: Resource object representing payment_voucher
                      required:
                      - payment_voucher
                      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: []
  /invoices/{invoice-id}/payment_vouchers:
    get:
      summary: List vouchers for an_invoice
      description: |
        Retrieves vouchers for an invoice in reverse chronological order.
      operationId: list_vouchers_for_an_invoice
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: invoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/invoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Current status of Payment Voucher. Possible values are : active, consumed, expired, failure.

          **Supported operators :**
          is, is_not, in, not_in, in, not_in

          **Example →**
          *status\[is\] = "active, consumed, expired"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "active, consumed, expired"
          properties:
            is:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              example: null
            is_not:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              example: null
            in:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              pattern: "^\\[(active|consumed|expired|failure)(,(active|consumed|expired|failure))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection
              enum:
              - active
              - consumed
              - expired
              - failure
              pattern: "^\\[(active|consumed|expired|failure)(,(active|consumed|expired|failure))*\\\
                ]$"
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

          Sorts based on the specified attribute.
          **Supported attributes :**
          date, updated_at

          **Supported sort-orders :**
          asc, desc

          **Example →**
          *sort_by\[asc\] = "date"*

          This will sort the result based on the 'date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - date
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - date
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        payment_voucher:
                          $ref: "#/components/schemas/PaymentVoucher"
                          description: Resource object representing payment_voucher
                      required:
                      - payment_voucher
                      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: []
  /payment_vouchers/{payment-voucher-id}:
    get:
      summary: Retrieve voucher data
      description: |-
        <div class="api-description"><p class="mb-2">Retrieves a voucher using the unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_voucher_id</code>
        .</p></div>
      operationId: retrieve_voucher_data
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: payment-voucher-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/payment-voucher-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_voucher:
                    $ref: "#/components/schemas/PaymentVoucher"
                    description: <p class="mb-2">Resource object representing payment_voucher</p>
                required:
                - payment_voucher
                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: []
  /payment_vouchers:
    post:
      summary: Create a voucher for the customer to initiate payment
      description: |
        Creates a voucher type payment source. If you create this voucher type payment source using customer details, like tax ID, you can then generate a voucher with that payment source.
      operationId: create_a_voucher_for_the_customer_to_initiate_payment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier of the customer for whom you want to create the voucher.
                  maxLength: 50
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the payment source used for generating the voucher.
                  maxLength: 40
                  example: null
                voucher_payment_source:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for voucher_payment_source
                  properties:
                    voucher_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of voucher-based payment source.
                        \* boleto -

                        The payment source is Boleto.
                      enum:
                      - boleto
                      example: null
                  required:
                  - voucher_type
                  example: null
                invoice_allocations:
                  type: object
                  deprecated: false
                  description: <p class="mb-2">Parameters for <code class="bg-gray-100
                    text-gray-800 font-medium border border-gray-300 rounded px-1.5
                    py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_allocations</code></p>
                  properties:
                    invoice_id:
                      type: array
                      description: |
                        The unique identifier of the invoice. You can pass multiple invoices ID.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - invoice_id
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              invoice_allocations:
                style: deepObject
                explode: true
              voucher_payment_source:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_voucher:
                    $ref: "#/components/schemas/PaymentVoucher"
                    description: <p class="mb-2">Resource object representing payment_voucher</p>
                required:
                - payment_voucher
                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: []
  /csv_tax_rules:
    post:
      summary: Taxes Csv import
      operationId: taxes_csv_import
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                tax_profile_name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                country:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                state:
                  type: string
                  default: '*'
                  deprecated: false
                  maxLength: 50
                  example: null
                zip_code:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                zip_code_start:
                  type: integer
                  format: int32
                  deprecated: false
                  example: null
                zip_code_end:
                  type: integer
                  format: int32
                  deprecated: false
                  example: null
                tax1_name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                tax1_rate:
                  type: number
                  format: double
                  deprecated: false
                  maximum: 100
                  minimum: 0
                  example: null
                tax1_juris_type:
                  type: string
                  deprecated: false
                  enum:
                  - country
                  - federal
                  - state
                  - county
                  - city
                  - special
                  - unincorporated
                  - other
                  example: null
                tax1_juris_name:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax1_juris_code:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax2_name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                tax2_rate:
                  type: number
                  format: double
                  deprecated: false
                  maximum: 100
                  minimum: 0
                  example: null
                tax2_juris_type:
                  type: string
                  deprecated: false
                  enum:
                  - country
                  - federal
                  - state
                  - county
                  - city
                  - special
                  - unincorporated
                  - other
                  example: null
                tax2_juris_name:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax2_juris_code:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax3_name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                tax3_rate:
                  type: number
                  format: double
                  deprecated: false
                  maximum: 100
                  minimum: 0
                  example: null
                tax3_juris_type:
                  type: string
                  deprecated: false
                  enum:
                  - country
                  - federal
                  - state
                  - county
                  - city
                  - special
                  - unincorporated
                  - other
                  example: null
                tax3_juris_name:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax3_juris_code:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax4_name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                tax4_rate:
                  type: number
                  format: double
                  deprecated: false
                  maximum: 100
                  minimum: 0
                  example: null
                tax4_juris_type:
                  type: string
                  deprecated: false
                  enum:
                  - country
                  - federal
                  - state
                  - county
                  - city
                  - special
                  - unincorporated
                  - other
                  example: null
                tax4_juris_name:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                tax4_juris_code:
                  type: string
                  deprecated: false
                  maxLength: 250
                  example: null
                service_type:
                  type: string
                  deprecated: false
                  enum:
                  - digital
                  - other
                  - not_applicable
                  example: null
                time_zone:
                  type: string
                  deprecated: false
                  maxLength: 4
                  example: null
                valid_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  example: null
                valid_till:
                  type: integer
                  format: unix-time
                  deprecated: false
                  example: null
                overwrite:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  csv_tax_rule:
                    $ref: "#/components/schemas/CsvTaxRule"
                    description: Resource object representing csv_tax_rule
                required:
                - csv_tax_rule
                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: []
  /currencies/{site-currency-id}/add_schedule:
    post:
      summary: Add schedule
      description: |-
        <div class="api-description"><p class="mb-2">This API is used to schedule exchange rate modification for a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
        currency.</p></div>
      operationId: add_schedule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: site-currency-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/site-currency-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                manual_exchange_rate:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This parameter allows you to pass the exchange rate in decimal format. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
                    you have to set the exchange rate for additional currencies in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
                    parameter. A maximum of <strong class="font-semibold">nine</strong>
                    decimal values are allowed to pass in this field.</p>
                  maxLength: 20
                  example: null
                schedule_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Timestamp at which the exchange rate scheduled has to be updated in your site. This timestamp must be a future date.
                  example: null
              required:
              - manual_exchange_rate
              - schedule_at
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  scheduled_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    example: null
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: <p class="mb-2">Resource object representing currency</p>
                required:
                - currency
                - scheduled_at
                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: []
  /currencies:
    post:
      summary: Add a new currency
      description: |-
        <div class="api-description"><p class="mb-2">This API is used to add a new currency to your Chargebee site. Prior to using this API, ensure that the <a href="https://www.chargebee.com/docs/1.0/multi-currency-pricing.html#1-adding-and-managing-currencies" target="_blank">multi-currency feature</a>
        is enabled.
        If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
        is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
        , you can specify the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
        . Additionally, the currency code provided must adhere to the three-letter ISO standard currency codes.</p></div>
      operationId: add_a_new_currency
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    A three letter currency code. For example, GBR, INR, and more.
                  maxLength: 3
                  example: null
                forex_type:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This represents the exchange rate type set for the currency.</p>
                    * auto - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto</code>
                    , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)</p>
                    * manual - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
                    , you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it</p>
                  enum:
                  - manual
                  - auto
                  example: null
                manual_exchange_rate:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This parameter allows you to pass the exchange rate in decimal format. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
                    you have to set the exchange rate for additional currencies in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
                    parameter. A maximum of <strong class="font-semibold">nine</strong>
                    decimal values are allowed to pass in this field.</p>
                  maxLength: 20
                  example: null
              required:
              - currency_code
              - forex_type
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: <p class="mb-2">Resource object representing currency</p>
                required:
                - currency
                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: []
  /currencies/{site-currency-id}:
    get:
      summary: Retrieve a currency
      description: |
        This API is used to retrieve an individual currency object configured within this site.
      operationId: retrieve_a_currency
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: site-currency-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/site-currency-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: <p class="mb-2">Resource object representing currency</p>
                required:
                - currency
                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: []
    post:
      summary: Update a currency
      description: |-
        <div class="api-description"><p class="mb-2">This API is used to update the configured currencies within your Chargebee site.
        Additionally, If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
        is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
        , you can specify the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
        .</p></div>
      operationId: update_a_currency
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: site-currency-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/site-currency-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                forex_type:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">This represents the exchange rate type set for the currency.</p>
                    * auto - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto</code>
                    , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)</p>
                    * manual - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
                    , you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it</p>
                  enum:
                  - manual
                  - auto
                  example: null
                manual_exchange_rate:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">TThis parameter allows you to pass the exchange rate in decimal format. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
                    is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
                    you have to set the exchange rate for additional currencies in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
                    parameter. A maximum of <strong class="font-semibold">nine</strong>
                    decimal values are allowed to pass in this field.</p>
                  maxLength: 20
                  example: null
              required:
              - forex_type
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: <p class="mb-2">Resource object representing currency</p>
                required:
                - currency
                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: []
  /currencies/{site-currency-id}/remove_schedule:
    post:
      summary: Remove schedule
      description: |
        This API allows you to remove a scheduled exchange rate from a currency.
      operationId: remove_schedule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: site-currency-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/site-currency-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  scheduled_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    example: null
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: <p class="mb-2">Resource object representing currency</p>
                required:
                - currency
                - scheduled_at
                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: []
  /currencies/list:
    get:
      summary: List currencies
      description: |
        This API is used to retrieve the list of all currencies currently configured within the site.
      operationId: list_currencies
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - 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.
          maximum: 100
          minimum: 1
          example: null
      - 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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        currency:
                          $ref: "#/components/schemas/Currency"
                          description: Resource object representing currency
                      required:
                      - currency
                      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: []
  /pc2_migrations/{pc2-migration-id}/contact_support:
    post:
      summary: Contact_support a pc2_migration
      operationId: contact_support_a_pc2_migration
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration:
                    $ref: "#/components/schemas/Pc2Migration"
                    description: Resource object representing pc2_migration
                required:
                - pc2_migration
                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: []
  /pc2_migrations/{pc2-migration-id}:
    get:
      summary: Retrieve a pc2 migration
      operationId: retrieve_a_pc2_migration
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: pc2-migration-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration:
                    $ref: "#/components/schemas/Pc2Migration"
                    description: Resource object representing pc2_migration
                required:
                - pc2_migration
                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: []
  /pc2_migrations:
    post:
      summary: Create a pc2_migration
      operationId: create_a_pc2_migration
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration:
                    $ref: "#/components/schemas/Pc2Migration"
                    description: Resource object representing pc2_migration
                required:
                - pc2_migration
                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: []
  /pc2_migrations/{pc2-migration-id}/initiate:
    post:
      summary: Initiate a pc2_migration
      operationId: initiate_a_pc2_migration
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration:
                    $ref: "#/components/schemas/Pc2Migration"
                    description: Resource object representing pc2_migration
                required:
                - pc2_migration
                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: []
  /pc2_migration_item_families/{pc2-migration-item-family-id}/delete:
    post:
      summary: Delete draft family
      operationId: delete_draft_family
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-family-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_deleted:
                    type: boolean
                    deprecated: false
                    example: null
                required:
                - is_deleted
                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: []
  /pc2_migration_item_families/{pc2-migration-item-family-id}:
    get:
      summary: Retrieve a pc2 migration item family
      operationId: retrieve_a_pc2_migration_item_family
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: pc2-migration-item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-family-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item_family:
                    $ref: "#/components/schemas/Pc2MigrationItemFamily"
                    description: Resource object representing pc2_migration_item_family
                required:
                - pc2_migration_item_family
                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: []
    post:
      summary: Update a pc2_migration_item_family
      operationId: update_a_pc2_migration_item_family
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-family-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                is_default:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                description:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item_family:
                    $ref: "#/components/schemas/Pc2MigrationItemFamily"
                    description: Resource object representing pc2_migration_item_family
                required:
                - pc2_migration_item_family
                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: []
  /pc2_migration_item_families:
    get:
      summary: List pc2 migration item families
      operationId: list_pc2_migration_item_families
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/limit"
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/offset"
        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.
          maxLength: 1000
          example: null
      - name: pc2_migration_id
        in: query
        required: true
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            pc2_migration reference key
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        pc2_migration_item_family:
                          $ref: "#/components/schemas/Pc2MigrationItemFamily"
                          description: Resource object representing pc2_migration_item_family
                      required:
                      - pc2_migration_item_family
                      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: []
    post:
      summary: Create a pc2_migration_item_family
      operationId: create_a_pc2_migration_item_family
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                is_default:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                pc2_migration_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
              required:
              - id
              - name
              - pc2_migration_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item_family:
                    $ref: "#/components/schemas/Pc2MigrationItemFamily"
                    description: Resource object representing pc2_migration_item_family
                required:
                - pc2_migration_item_family
                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: []
  /pc2_migration_items/{pc2-migration-item-id}:
    get:
      summary: Retrieve a pc2 migration item
      operationId: retrieve_a_pc2_migration_item
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: pc2-migration-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item:
                    $ref: "#/components/schemas/Pc2MigrationItem"
                    description: Resource object representing pc2_migration_item
                required:
                - pc2_migration_item
                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: []
    post:
      summary: Update a pc2_migration_item
      operationId: update_a_pc2_migration_item
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                id:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                pc2_migration_item_family_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                metadata:
                  type: string
                  deprecated: false
                  maxLength: 65000
                  example: null
                is_giftable:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                enabled_for_checkout:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                is_recurring:
                  type: boolean
                  default: true
                  deprecated: false
                  example: null
                gift_claim_redirect_url:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  example: null
                unit:
                  type: string
                  deprecated: false
                  maxLength: 30
                  example: null
                pc2_migration_item_prices:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    name:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    metadata:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    ref_entity_id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  - ref_entity_id
                  example: null
              example: null
            encoding:
              pc2_migration_item_prices:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item:
                    $ref: "#/components/schemas/Pc2MigrationItem"
                    description: Resource object representing pc2_migration_item
                required:
                - pc2_migration_item
                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: []
  /pc2_migration_items/{pc2-migration-item-id}/delete:
    post:
      summary: Delete draft item
      operationId: delete_draft_item
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_deleted:
                    type: boolean
                    deprecated: false
                    example: null
                required:
                - is_deleted
                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: []
  /pc2_migration_items:
    get:
      summary: List pc2 migration items
      operationId: list_pc2_migration_items
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/limit"
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/offset"
        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.
          maxLength: 1000
          example: null
      - name: pc2_migration_item_family
        in: query
        required: true
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            Parameters for pc2_migration_item_family
          properties:
            pc2_migration_id:
              type: object
              deprecated: false
              description: |
                pc2_migration reference key
              properties:
                is:
                  type: string
                  minLength: 1
                  example: null
                is_not:
                  type: string
                  minLength: 1
                  example: null
                starts_with:
                  type: string
                  minLength: 1
                  example: null
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        pc2_migration_item:
                          $ref: "#/components/schemas/Pc2MigrationItem"
                          description: Resource object representing pc2_migration_item
                      required:
                      - pc2_migration_item
                      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: []
    post:
      summary: Create a pc2_migration_item
      operationId: create_a_pc2_migration_item
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                pc1_type:
                  type: string
                  deprecated: false
                  enum:
                  - plan
                  - addon
                  example: null
                pc2_migration_item_family_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                pc2_migration_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                metadata:
                  type: string
                  deprecated: false
                  maxLength: 65000
                  example: null
                is_giftable:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                is_shippable:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                enabled_for_checkout:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                enabled_in_portal:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                is_recurring:
                  type: boolean
                  default: true
                  deprecated: false
                  example: null
                gift_claim_redirect_url:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  example: null
                unit:
                  type: string
                  deprecated: false
                  maxLength: 30
                  example: null
                pc2_migration_item_prices:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    name:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    description:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    metadata:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    ref_entity_id:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  - ref_entity_id
                  example: null
              required:
              - id
              - name
              - pc1_type
              - pc2_migration_id
              example: null
            encoding:
              pc2_migration_item_prices:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item:
                    $ref: "#/components/schemas/Pc2MigrationItem"
                    description: Resource object representing pc2_migration_item
                required:
                - pc2_migration_item
                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: []
  /pc2_migration_items/applicable_items:
    get:
      summary: Applicable_items a pc2_migration_item
      operationId: applicable_items_a_pc2_migration_item
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/limit"
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/offset"
        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.
          maxLength: 1000
          example: null
      - name: is_recurring
        in: query
        required: true
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        pc2_migration_applicable_item:
                          $ref: "#/components/schemas/Pc2MigrationApplicableItem"
                          description: Resource object representing pc2_migration_applicable_item
                      required:
                      - pc2_migration_applicable_item
                      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: []
  /pc2_migration_item_prices:
    get:
      summary: List pc2 migration item prices
      operationId: list_pc2_migration_item_prices
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/limit"
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/offset"
        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.
          maxLength: 1000
          example: null
      - name: pc2_migration_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            pc2_migration reference key
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
          example: null
      - name: pc2_migration_item_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            item reference key
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
          example: null
      - name: is_invalid_pc1_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            check if pc1 autocorrection required
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
          example: null
      - name: pc1_item_type
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |
                \* \`plan\` - PLAN \* \`addon\` - ADDON
              enum:
              - plan
              - addon
              example: null
            is_not:
              type: string
              description: |
                \* \`plan\` - PLAN \* \`addon\` - ADDON
              enum:
              - plan
              - addon
              example: null
            in:
              type: string
              description: |
                \* \`plan\` - PLAN \* \`addon\` - ADDON
              enum:
              - plan
              - addon
              pattern: "^\\[(plan|addon)(,(plan|addon))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                \* \`plan\` - PLAN \* \`addon\` - ADDON
              enum:
              - plan
              - addon
              pattern: "^\\[(plan|addon)(,(plan|addon))*\\]$"
              example: null
          example: null
      - name: is_recurring
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        pc2_migration_item_price:
                          $ref: "#/components/schemas/Pc2MigrationItemPrice"
                          description: Resource object representing pc2_migration_item_price
                      required:
                      - pc2_migration_item_price
                      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: []
  /pc2_migration_item_prices/{pc2-migration-item-price-id}/delete:
    post:
      summary: Delete draft item price
      operationId: delete_draft_item_price
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_deleted:
                    type: boolean
                    deprecated: false
                    example: null
                required:
                - is_deleted
                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: []
  /pc2_migration_item_prices/{pc2-migration-item-price-id}:
    get:
      summary: Retrieve a pc2 migration item price
      operationId: retrieve_a_pc2_migration_item_price
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: pc2-migration-item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item_price:
                    $ref: "#/components/schemas/Pc2MigrationItemPrice"
                    description: Resource object representing pc2_migration_item_price
                required:
                - pc2_migration_item_price
                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: []
    post:
      summary: Update a pc2_migration_item_price
      operationId: update_a_pc2_migration_item_price
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: pc2-migration-item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/pc2-migration-item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                pc2_migration_item_id:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                metadata:
                  type: string
                  deprecated: false
                  maxLength: 500
                  example: null
                sanitized_pc1_id:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                is_primary_attached_item:
                  type: boolean
                  default: false
                  deprecated: false
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pc2_migration_item_price:
                    $ref: "#/components/schemas/Pc2MigrationItemPrice"
                    description: Resource object representing pc2_migration_item_price
                required:
                - pc2_migration_item_price
                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: []
  /site_pc_meta_records:
    get:
      summary: List site pc meta records
      operationId: list_site_pc_meta_records
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/limit"
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        required: false
        deprecated: false
        $ref: "#/components/parameters/offset"
        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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        site_pc_meta_record:
                          $ref: "#/components/schemas/SitePcMetaRecord"
                          description: Resource object representing site_pc_meta_record
                      required:
                      - site_pc_meta_record
                      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: []
  /rules/{rule-id}:
    get:
      summary: Retrieve rule data
      operationId: retrieve_rule_data
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rule:
                    $ref: "#/components/schemas/Rule"
                    description: Resource object representing rule
                required:
                - rule
                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: []
  /usage_events:
    post:
      summary: Ingest a usage event
      description: |
        This endpoint allows you to ingest a usage event into Chargebee. The usage event is processed through associated meters, price plans, or entitlements to generate the final billable value for invoicing the customer.
      operationId: create_a_usage_event
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                deduplication_id:
                  type: string
                  deprecated: false
                  description: ""
                  maxLength: 36
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    A unique identifier of a subscription entity.
                  maxLength: 50
                  example: null
                usage_timestamp:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Timestamp at which this usage occurred.
                  example: null
                properties:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    List of attributes or dimension attributes defined in the meter.
                  example: null
              required:
              - deduplication_id
              - properties
              - subscription_id
              - usage_timestamp
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage_event:
                    $ref: "#/components/schemas/UsageEvent"
                    description: <p class="mb-2">Resource object representing usage_event</p>
                required:
                - usage_event
                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: []
      servers:
      - url: "{protocol}://{site}.ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /batch/usage_events:
    post:
      summary: Ingest usages in batch
      description: |
        This endpoint allows you to ingest a batch of usage events into Chargebee. The usage events are processed through associated meters, price plans, or entitlements to generate the final billable value for invoicing the customer.
      operationId: ingest_usages_in_batch
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                events:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for events
                  properties:
                    deduplication_id:
                      type: array
                      description: |
                        A unique identifier generated by the client to prevent duplicate event processing.
                        Meter's DedupCriteria specifies whether to replace or discard duplicate events based on timestamp, idempotency key, or both.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 36
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: |
                        A unique identifier of an subscription entity.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    usage_timestamp:
                      type: array
                      description: |
                        Timestamp at which this usage occurred.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    properties:
                      type: array
                      description: |
                        List of attributes or dimension attributes belongs to a meter defined in event name. Meter filter and group the usage events with dimension attributes priorly and perform the aggregation on attributes.
                      items:
                        type: object
                        additionalProperties: true
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - deduplication_id
                  - properties
                  - subscription_id
                  - usage_timestamp
                  example: null
              example: null
            encoding:
              events:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  batch_id:
                    type: string
                    deprecated: false
                    x-cb-attribute-pcv: 2
                    maxLength: 36
                    example: null
                  failed_events:
                    type: array
                    deprecated: false
                    items:
                      example: null
                    example: null
                required:
                - batch_id
                - failed_events
                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: []
      servers:
      - url: "{protocol}://{site}.ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /usage_files/{usage-file-id}/processing_status:
    get:
      description: ""
      operationId: get_uploaded_file_processing_status
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: usage-file-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/usage-file-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage_file:
                    $ref: "#/components/schemas/UsageFile"
                    description: <p class="mb-2">Resource object representing usage_file</p>
                required:
                - usage_file
                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: []
      servers:
      - url: "{protocol}://{site}.file-ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.file-ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /usage_files/upload_url:
    post:
      description: ""
      operationId: get_usages_file_upload_url
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                file_name:
                  type: string
                  deprecated: false
                  description: |
                    Name of the file being uploaded.
                  maxLength: 150
                  example: null
                mime_type:
                  type: string
                  deprecated: false
                  description: |
                    MIME type of the uploaded file (e.g., application/json, text/csv).
                  maxLength: 100
                  example: null
              required:
              - file_name
              - mime_type
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage_file:
                    $ref: "#/components/schemas/UsageFile"
                    description: <p class="mb-2">Resource object representing usage_file</p>
                required:
                - usage_file
                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: []
      servers:
      - url: "{protocol}://{site}.file-ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.file-ingest.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /personalized_offers:
    post:
      summary: List personalized offers
      description: |
        This API is used to retrieve a list of personalized offer(s) for a customer based on the context (such as customer or subscription details and end-user attributes). This allows you to retrieve any active offers targeted to the user.
        You can pre-call this API as soon as you have the user context at the point of login, or can call this API at any other point in the user journey when an offer is to be shown.

        System evaluates eligibility and mapping to the right offer based on:

        * Customer profile and subscription information.
        * Device and browsing context.
        * Custom fields.
        * Play configurations.

        If no eligible offers are found, the API returns an empty list. (No error is thrown in this case; an empty result is a valid response).

        **Features of this API**

        The List Personalized Offers endpoint allows you to:

        * Retrieve context-aware offers targeted to customers or end users.
        * Leverage multiple signals (profile, subscription, device/browser context, custom fields, and plays).
        * Call flexibly at login, checkout, renewal, or any point in the user journey.Handle gracefully when no offers are available (returns an empty list, not an error).
        * Support both B2C (single user per customer) and B2B (multiple end users per customer) scenarios. **Note:** Although the response is modeled as a list, the API currently returns at most one personalized offer (the best-matched offer for the user). If no offers are available, the list will be empty.
      operationId: list_personalized_offers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    First name of the customer. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)
                    .
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    Last name of the customer. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)
                    .
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    Customer's email address. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)
                    .
                  maxLength: 70
                  example: null
                roles:
                  type: array
                  deprecated: false
                  description: |
                    Roles or user types associated with the end user. (Useful in offer targeting for B2B scenarios with multiple user roles.).
                  items:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  example: null
                external_user_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier of the user in the merchant's system. This is used to identify the user for whom the offer is being created.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier of the subscription for which the offer should be retrieved.
                    **Notes:**

                    * **Required** if multiple brands are configured in your Growth application.
                    * **Recommended** to always provide.
                    * If omitted and the customer has multiple subscriptions, the system attempts to retrieve the offer associated with one of their subscriptions.
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the customer in the billing system (Chargebee customer ID).
                  maxLength: 50
                  example: null
                custom:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    JSON object of custom attributes (key-value pairs) used for offer targeting or content. \[Configure\](https://www.chargebee.com/docs/retention/settings-and-installation/chargebee-retention-field-mappings) custom attributes in the dashboard.
                  example: null
                request_context:
                  type: object
                  deprecated: false
                  description: |
                    A JSON object with standard context attributes (browser, device, locale, etc.) of the end user's session. This can help in offer targeting based on user environment.
                  properties:
                    user_agent:
                      type: string
                      deprecated: false
                      description: |
                        The user's browser or device user agent string. Helps determine browser and platform details.
                        For example, chrome/7.10
                      maxLength: 255
                      example: null
                    locale:
                      type: string
                      deprecated: false
                      description: |
                        The user's locale setting (e.g., en-US, fr-FR). Useful for regional offer targeting.
                      maxLength: 50
                      example: null
                    timezone:
                      type: string
                      deprecated: false
                      description: |
                        The user's timezone identifier (e.g., America/New_York). Used for contextual targeting based on time.
                      maxLength: 64
                      example: null
                    url:
                      type: string
                      deprecated: false
                      description: |
                        The current page URL where the offer is being displayed. Useful for context-sensitive offers.
                      maxLength: 250
                      example: null
                    referrer_url:
                      type: string
                      deprecated: false
                      description: |
                        The referring page URL, i.e., the previous page that navigated the user to the current one. Can help with attribution analysis.
                      maxLength: 250
                      example: null
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              request_context:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  personalized_offers:
                    type: array
                    description: <p class="mb-2">List of best offers to be shown to
                      the customer. Currently this will always return one personalized
                      offer. This will be empty if no best offers are found.</p>
                    items:
                      $ref: "#/components/schemas/PersonalizedOffer"
                      description: Resource object representing personalized_offer
                    example: null
                  brand:
                    $ref: "#/components/schemas/Brand"
                    description: <p class="mb-2">Resource object representing brand</p>
                  expires_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: "<p class=\"mb-2\">The timestamp until which the\
                      \ offer remains active. After this time, you must retrieve the\
                      \ offer again via the List Personalised Offers API to get the\
                      \ latest.</p>"
                    example: null
                required:
                - expires_at
                - personalized_offers
                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: []
      servers:
      - url: "{protocol}://{site}.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /offer_fulfillments:
    post:
      summary: Create an offer fulfillment
      description: |-
        <div class="api-description"><p class="mb-2">This API notifies that a user has accepted an offer, logs an accepted event immediately for reporting, and triggers a backend processing depending on the offer&#x27;s processing_type.
        You can call this API when a user accepts an offer (e.g., the user clicked Accept Offer or a similar confirmation).
        This API will record an accepted event as soon as the API is called and initiate the appropriate fulfillment mechanism according to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">processing_type</code>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_update</code>: Initiates subscription or billing record updates (e.g., applying a discount or changing a plan) asynchronously.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout</code>: Returns a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object in the response, which contains a URL to render the hosted checkout flow.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">url_redirect</code>: Returns a redirect_url. You are responsible for managing fulfillment on your end and must call the Update Offer Fulfillment API to report either completion or failure.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook</code>: Sends a webhook, and you must also manage fulfillment on your end. Be sure to call the Update Offer Fulfillment API to report completion or failure.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>: Sends an email containing the offer details as configured. You are responsible for handling fulfillment on your side and must call the Update Offer Fulfillment API to report completion or failure.
        You can poll the Retrieve Offer Fulfillment endpoint for final status on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_update</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout flows</code>.
        Upon actual fulfillment completion, the system logs a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fulfilled</code> event and sends notifications (webhook, Slack, email, Segment) as configured.</li>
        </ul></div>
      operationId: create_an_offer_fulfillment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                personalized_offer_id:
                  type: string
                  deprecated: false
                  description: |
                    ID of the personalized offer that was accepted.
                  maxLength: 50
                  example: null
                option_id:
                  type: string
                  deprecated: false
                  description: |
                    ID of the Offer Option that the user accepted.
                  maxLength: 50
                  example: null
              required:
              - option_id
              - personalized_offer_id
              example: null
            encoding: {}
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  offer_fulfillment:
                    $ref: "#/components/schemas/OfferFulfillment"
                    description: <p class="mb-2">Represents the fulfillment created
                      for the offer.</p>
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: |-
                      <p class="mb-2">Represents the hosted page created for the offer. This is returned only if the selected offer option&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">processing_type</code>
                      is checkout.</p>
                required:
                - offer_fulfillment
                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: []
      servers:
      - url: "{protocol}://{site}.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /offer_fulfillments/{offer-fulfillment-id}:
    get:
      summary: Retrieve an offer fulfillment
      description: |
        This API is used to retrieve the fulfillment record. This is typically used to check the latest status of an asynchronous offer fulfillment. You can use this after creating an offer fulfillment (billing update or checkout).
      operationId: retrieve_an_offer_fulfillment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: offer-fulfillment-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/offer-fulfillment-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offer_fulfillment:
                    $ref: "#/components/schemas/OfferFulfillment"
                    description: <p class="mb-2">Represents the fulfillment created
                      for the offer.</p>
                required:
                - offer_fulfillment
                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: []
      servers:
      - url: "{protocol}://{site}.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
    post:
      summary: Update an offer fulfillment
      description: |-
        <div class="api-description"><p class="mb-2">This API is used to update the status of offer fulfillment for the processing types <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">url_redirect</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code> as Chargebee cannot automatically fulfill these offers.
        If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status = failed</code>, you must include a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failure_reason</code> to explain why the fulfillment did not succeed. The system logs a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fulfilled</code> event when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status = completed</code> or a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code> event when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status = failed</code>.
        <strong class="font-semibold">Note</strong>: If the offer fulfillment is not marked as completed or failed within 7 days, Chargebee will mark the offer fulfillment as failed with the error code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">external_fulfillment_failed</code>.</p></div>
      operationId: update_an_offer_fulfillment
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: offer-fulfillment-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/offer-fulfillment-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    ID of the fulfillment that is being updated.
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Final state of the fulfillment.
                    \* failed -

                    Pass this if the fulfillment is failed.
                    \* completed -

                    Pass this if the fulfillment is completed.
                  enum:
                  - completed
                  - failed
                  example: null
                failure_reason:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Explanation for failure; required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                    = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code>
                    .</p>
                  maxLength: 100
                  example: null
              required:
              - id
              - status
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offer_fulfillment:
                    $ref: "#/components/schemas/OfferFulfillment"
                    description: <p class="mb-2">Represents the fulfillment created
                      for the offer.</p>
                required:
                - offer_fulfillment
                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: []
      servers:
      - url: "{protocol}://{site}.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /offer_events:
    post:
      summary: Create an offer event
      description: |-
        <div class="api-description"><p class="mb-2">The Create Offer Event API records user interactions with an offer for tracking and analytics purposes.
        Use this API to log user-triggered engagement events such as:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">viewed</code> - when an offer is displayed to the user.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dismissed</code> - when the user closes or ignores the offer.
        These events are essential for accurate offer performance reporting and funnel analysis. Make sure to send them as they happen.</li>
        </ul><p class="mb-2"><strong class="font-semibold">Note:</strong> System-driven events like accepted and fulfilled are captured automatically by the growth system through fulfillment workflows. You do not need to post these.</p></div>
      operationId: create_an_offer_event
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                personalized_offer_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the personalized offer the event pertains to.
                  maxLength: 50
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The type of engagement event to be recorded.
                    \* dismissed -

                    Logged when the user closes or ignores the offer without accepting
                    \* viewed -

                    Logged when the user's UI renders or displays the offer
                  enum:
                  - viewed
                  - dismissed
                  example: null
              required:
              - personalized_offer_id
              - type
              example: null
            encoding: {}
      responses:
        "204":
          description: No Content
        "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: []
      servers:
      - url: "{protocol}://{site}.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
      - url: "{protocol}://{site}-test.grow.{environment}:{port}/api/v2"
        variables:
          protocol:
            default: https
            enum:
            - http
            - https
          site:
            default: demo
          environment:
            default: chargebee.com
            enum:
            - chargebee.com
          port:
            default: "443"
            enum:
            - "443"
            - "8080"
  /webhook_endpoints/{webhook-endpoint-id}/delete:
    post:
      summary: Delete a webhook endpoint
      description: |
        Deletes a webhook endpoint using its unique identifier. Use this API to remove obsolete or inactive webhook endpoints from your Chargebee site. Deleting an endpoint ensures it no longer receives event notifications.
      operationId: delete_a_webhook_endpoint
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: webhook-endpoint-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/webhook-endpoint-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_endpoint:
                    $ref: "#/components/schemas/WebhookEndpoint"
                    description: |-
                      <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook_endpoint</code>
                      resource object that contains the configuration and details of the created webhook.</p>
                required:
                - webhook_endpoint
                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: []
  /webhook_endpoints/{webhook-endpoint-id}:
    get:
      summary: Retrieve a webhook endpoint
      description: |
        Retrieves the details of a specific webhook endpoint using its unique identifier. Use this API to inspect an endpoint's configuration, such as the target URL, subscribed events, and authentication settings.
      operationId: retrieve_a_webhook_endpoint
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: webhook-endpoint-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/webhook-endpoint-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_endpoint:
                    $ref: "#/components/schemas/WebhookEndpoint"
                    description: |-
                      <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook_endpoint</code>
                      resource object that contains the configuration and details of the created webhook.</p>
                required:
                - webhook_endpoint
                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: []
    post:
      summary: Update webhook endpoint
      description: |
        Updates the configuration of an existing webhook endpoint using its unique identifier. You can use this API to change properties such as the name, URL, subscribed events, authentication credentials, or API version. This is useful when rotating endpoints, updating destination URLs, or modifying which events your system listens to.
      operationId: update_a_webhook_endpoint
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      - name: webhook-endpoint-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/webhook-endpoint-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    A name to identify the webhook endpoint.
                  maxLength: 50
                  example: null
                api_version:
                  type: string
                  default: v2
                  deprecated: false
                  description: |
                    The API version used to format the webhook payload. Ensure this version matches the client library used by your webhook server.
                    \* v1 -

                    If selected, the payload includes only attributes from API v1 resources.
                    \* v2 -

                    If selected, the payload includes only attributes from API v2 resources.
                  enum:
                  - v1
                  - v2
                  example: null
                url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The target URL where webhook notifications will be sent.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    Only URL ports <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">80</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">443</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">8080</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">8443</code> are allowed.</p></div>
                  maxLength: 512
                  example: null
                primary_url:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Controls whether card-related resources are included in the webhook payload. Card details are always masked.
                  example: null
                send_card_resource:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Specifies whether card-related resources should be included in the webhook payload.
                  example: null
                basic_auth_password:
                  type: string
                  deprecated: false
                  description: |
                    The password used for basic authentication to secure webhook delivery.
                  maxLength: 250
                  example: null
                basic_auth_username:
                  type: string
                  deprecated: false
                  description: |
                    Username for basic authentication used to secure webhook delivery.
                  maxLength: 250
                  example: null
                disabled:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates whether the webhook endpoint is disabled. Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    to disable the endpoint, set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    to enable the endpoint.</p>
                  example: null
                enabled_events:
                  type: array
                  deprecated: false
                  description: "A list of event types that trigger this webhook. \
                    \ \n**Note**\nIf this field is left empty, the webhook will enable\
                    \ [all event types](/docs/api/v2/pcv-1/webhook_endpoints) by default.\n"
                  items:
                    type: string
                    deprecated: false
                    enum:
                    - plan_created
                    - plan_updated
                    - plan_deleted
                    - addon_created
                    - addon_updated
                    - addon_deleted
                    - coupon_created
                    - coupon_updated
                    - coupon_deleted
                    - coupon_set_created
                    - coupon_set_updated
                    - coupon_set_deleted
                    - coupon_codes_added
                    - coupon_codes_deleted
                    - coupon_codes_updated
                    - customer_created
                    - customer_changed
                    - customer_deleted
                    - customer_moved_out
                    - customer_moved_in
                    - promotional_credits_added
                    - promotional_credits_deducted
                    - subscription_created
                    - subscription_created_with_backdating
                    - subscription_started
                    - subscription_trial_end_reminder
                    - subscription_activated
                    - subscription_activated_with_backdating
                    - subscription_changed
                    - subscription_trial_extended
                    - mrr_updated
                    - subscription_changed_with_backdating
                    - subscription_cancellation_scheduled
                    - subscription_cancellation_reminder
                    - subscription_cancelled
                    - subscription_canceled_with_backdating
                    - subscription_reactivated
                    - subscription_reactivated_with_backdating
                    - subscription_renewed
                    - subscription_items_renewed
                    - subscription_scheduled_cancellation_removed
                    - subscription_changes_scheduled
                    - subscription_scheduled_changes_removed
                    - subscription_shipping_address_updated
                    - subscription_deleted
                    - subscription_paused
                    - subscription_pause_scheduled
                    - subscription_scheduled_pause_removed
                    - subscription_resumed
                    - subscription_resumption_scheduled
                    - subscription_scheduled_resumption_removed
                    - subscription_advance_invoice_schedule_added
                    - subscription_advance_invoice_schedule_updated
                    - subscription_advance_invoice_schedule_removed
                    - pending_invoice_created
                    - pending_invoice_updated
                    - invoice_generated
                    - invoice_generated_with_backdating
                    - invoice_updated
                    - invoice_deleted
                    - credit_note_created
                    - credit_note_created_with_backdating
                    - credit_note_updated
                    - credit_note_deleted
                    - subscription_renewal_reminder
                    - transaction_created
                    - transaction_updated
                    - transaction_deleted
                    - payment_succeeded
                    - payment_failed
                    - dunning_updated
                    - payment_refunded
                    - payment_initiated
                    - refund_initiated
                    - authorization_succeeded
                    - authorization_voided
                    - card_added
                    - card_updated
                    - card_expiry_reminder
                    - card_expired
                    - card_deleted
                    - payment_source_added
                    - payment_source_updated
                    - payment_source_deleted
                    - payment_source_expiring
                    - payment_source_expired
                    - payment_source_locally_deleted
                    - virtual_bank_account_added
                    - virtual_bank_account_updated
                    - virtual_bank_account_deleted
                    - token_created
                    - token_consumed
                    - token_expired
                    - unbilled_charges_created
                    - unbilled_charges_voided
                    - unbilled_charges_deleted
                    - unbilled_charges_invoiced
                    - order_created
                    - order_updated
                    - order_cancelled
                    - order_delivered
                    - order_returned
                    - order_ready_to_process
                    - order_ready_to_ship
                    - order_deleted
                    - order_resent
                    - quote_created
                    - quote_updated
                    - quote_deleted
                    - tax_withheld_recorded
                    - tax_withheld_deleted
                    - tax_withheld_refunded
                    - gift_scheduled
                    - gift_unclaimed
                    - gift_claimed
                    - gift_expired
                    - gift_cancelled
                    - gift_updated
                    - hierarchy_created
                    - hierarchy_deleted
                    - payment_intent_created
                    - payment_intent_updated
                    - contract_term_created
                    - contract_term_renewed
                    - contract_term_terminated
                    - contract_term_completed
                    - contract_term_cancelled
                    - voucher_created
                    - voucher_expired
                    - voucher_create_failed
                    - subscription_ramp_created
                    - subscription_ramp_deleted
                    - subscription_ramp_applied
                    - subscription_ramp_drafted
                    - subscription_ramp_updated
                    - subscription_moved_in
                    - subscription_moved_out
                    - subscription_movement_failed
                    - omnichannel_subscription_created
                    - omnichannel_subscription_item_renewed
                    - omnichannel_subscription_item_downgraded
                    - omnichannel_subscription_item_expired
                    - omnichannel_subscription_item_cancellation_scheduled
                    - omnichannel_subscription_item_scheduled_cancellation_removed
                    - omnichannel_subscription_item_resubscribed
                    - omnichannel_subscription_item_upgraded
                    - omnichannel_subscription_item_cancelled
                    - omnichannel_subscription_imported
                    - omnichannel_subscription_item_grace_period_started
                    - omnichannel_subscription_item_grace_period_expired
                    - omnichannel_subscription_item_dunning_started
                    - omnichannel_subscription_item_dunning_expired
                    - rule_created
                    - rule_updated
                    - rule_deleted
                    - record_purchase_failed
                    - omnichannel_subscription_item_change_scheduled
                    - omnichannel_subscription_item_scheduled_change_removed
                    - omnichannel_subscription_item_reactivated
                    - sales_order_created
                    - sales_order_updated
                    - omnichannel_subscription_item_changed
                    - omnichannel_subscription_item_paused
                    - omnichannel_subscription_item_resumed
                    - omnichannel_one_time_order_created
                    - omnichannel_one_time_order_item_cancelled
                    - usage_file_ingested
                    - omnichannel_subscription_item_pause_scheduled
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_endpoint:
                    $ref: "#/components/schemas/WebhookEndpoint"
                    description: |-
                      <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook_endpoint</code>
                      resource object that contains the configuration and details of the created webhook.</p>
                required:
                - webhook_endpoint
                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: []
  /webhook_endpoints:
    get:
      summary: List webhook endpoints
      description: |
        Retrieves all webhook endpoints configured on your Chargebee site. The response includes each endpoint's ID, name, and target URL. Use this API to view, audit, or manage the list of webhook endpoints currently active or configured in your site.
      operationId: list_webhook_endpoints
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          description: |
            The number of resources to be returned.
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |-
          <p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
          to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
          obtained in the previous iteration of the API call.</p>
        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.
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        webhook_endpoint:
                          $ref: "#/components/schemas/WebhookEndpoint"
                          description: Resource object representing webhook_endpoint
                      required:
                      - webhook_endpoint
                      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: []
    post:
      summary: Create a webhook endpoint
      description: |
        Create a new webhook endpoint on your Chargebee Site.
      operationId: create_a_webhook_endpoint
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: |
          The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            The device from which the customer has made the request
          example: Android
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        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
      - 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
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        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
      - name: chargebee-request-origin-ip
        in: header
        description: |
          The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        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})))?::)))))$"
      - name: chargebee-event-actions
        in: header
        description: |
          skip all actions to be done on the events
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-actions"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip all actions to be done on the events
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-email
        in: header
        description: |
          skip only emails
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-email"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only emails
          enum:
          - all-disabled
          example: null
      - name: chargebee-event-webhook
        in: header
        description: |
          skip only webhooks
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-event-webhook"
        style: simple
        explode: false
        schema:
          type: string
          description: |
            skip only webhooks
          enum:
          - all-disabled
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    A name to identify the webhook endpoint.
                  maxLength: 50
                  example: null
                api_version:
                  type: string
                  default: v2
                  deprecated: false
                  description: |
                    The API version used to format the webhook payload. Ensure this version matches the client library used by your webhook server
                    \* v1 -

                    If selected, the payload includes only attributes from API v1 resources.
                    \* v2 -

                    If selected, the payload includes only attributes from API v2 resources.
                  enum:
                  - v1
                  - v2
                  example: null
                url:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The target URL where webhook notifications will be sent.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    Only URL ports <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">80</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">443</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">8080</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">8443</code> are allowed.</p></div>
                  maxLength: 512
                  example: null
                primary_url:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether this webhook is marked as the primary endpoint. If only one exists, it is primary by default.
                  example: null
                disabled:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates whether the webhook endpoint is disabled. Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
                    to disable the endpoint, set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
                    to enable the endpoint.</p>
                  example: null
                basic_auth_password:
                  type: string
                  deprecated: false
                  description: |
                    The password used for basic authentication to secure webhook delivery.
                  maxLength: 250
                  example: null
                basic_auth_username:
                  type: string
                  deprecated: false
                  description: |
                    Username for basic authentication used to secure webhook delivery.
                  maxLength: 250
                  example: null
                send_card_resource:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Controls whether card-related resources are included in the webhook payload. Card details are always masked.
                  example: null
                chargebee_response_schema_type:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">Indicates the response schema used in the webhook payload,  based on the product catalog version configured for the site.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
                    This field is only applicable if the site is in <a href="https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog-coexistence-ui-changes"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code></a> mode.</p></div>
                    * compat - <p class="mb-2">The webhook payload uses a schema compatible with both Product Catalog 1.0 and 2.0. This is applicable only to sites automatically upgraded to Product Catalog 2.0.</p>
                    * items - <p class="mb-2">The webhook payload follows the <a href="https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Product Catalog 2.0</a>
                    schema and uses the <a href="/docs/api/items">Items API model</a>
                    .</p>
                    * plans_addons - <p class="mb-2">The webhook payload follows the <a href="https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog">Product Catalog 1.0</a>
                    schema and uses the <a href="/docs/api/v2/pcv-1/plans">Plans</a>
                    and <a href="/docs/api/v2/pcv-1/addons">Addons</a>
                    model.</p>
                  enum:
                  - plans_addons
                  - items
                  - compat
                  example: null
                enabled_events:
                  type: array
                  deprecated: false
                  description: "A list of event types that trigger this webhook. \
                    \ \n**Note**\nIf this field is left empty, the webhook will enable\
                    \ [all event types](/docs/api/v2/pcv-1/webhook_endpoints) by default.\n"
                  items:
                    type: string
                    deprecated: false
                    enum:
                    - plan_created
                    - plan_updated
                    - plan_deleted
                    - addon_created
                    - addon_updated
                    - addon_deleted
                    - coupon_created
                    - coupon_updated
                    - coupon_deleted
                    - coupon_set_created
                    - coupon_set_updated
                    - coupon_set_deleted
                    - coupon_codes_added
                    - coupon_codes_deleted
                    - coupon_codes_updated
                    - customer_created
                    - customer_changed
                    - customer_deleted
                    - customer_moved_out
                    - customer_moved_in
                    - promotional_credits_added
                    - promotional_credits_deducted
                    - subscription_created
                    - subscription_created_with_backdating
                    - subscription_started
                    - subscription_trial_end_reminder
                    - subscription_activated
                    - subscription_activated_with_backdating
                    - subscription_changed
                    - subscription_trial_extended
                    - mrr_updated
                    - subscription_changed_with_backdating
                    - subscription_cancellation_scheduled
                    - subscription_cancellation_reminder
                    - subscription_cancelled
                    - subscription_canceled_with_backdating
                    - subscription_reactivated
                    - subscription_reactivated_with_backdating
                    - subscription_renewed
                    - subscription_items_renewed
                    - subscription_scheduled_cancellation_removed
                    - subscription_changes_scheduled
                    - subscription_scheduled_changes_removed
                    - subscription_shipping_address_updated
                    - subscription_deleted
                    - subscription_paused
                    - subscription_pause_scheduled
                    - subscription_scheduled_pause_removed
                    - subscription_resumed
                    - subscription_resumption_scheduled
                    - subscription_scheduled_resumption_removed
                    - subscription_advance_invoice_schedule_added
                    - subscription_advance_invoice_schedule_updated
                    - subscription_advance_invoice_schedule_removed
                    - pending_invoice_created
                    - pending_invoice_updated
                    - invoice_generated
                    - invoice_generated_with_backdating
                    - invoice_updated
                    - invoice_deleted
                    - credit_note_created
                    - credit_note_created_with_backdating
                    - credit_note_updated
                    - credit_note_deleted
                    - subscription_renewal_reminder
                    - transaction_created
                    - transaction_updated
                    - transaction_deleted
                    - payment_succeeded
                    - payment_failed
                    - dunning_updated
                    - payment_refunded
                    - payment_initiated
                    - refund_initiated
                    - authorization_succeeded
                    - authorization_voided
                    - card_added
                    - card_updated
                    - card_expiry_reminder
                    - card_expired
                    - card_deleted
                    - payment_source_added
                    - payment_source_updated
                    - payment_source_deleted
                    - payment_source_expiring
                    - payment_source_expired
                    - payment_source_locally_deleted
                    - virtual_bank_account_added
                    - virtual_bank_account_updated
                    - virtual_bank_account_deleted
                    - token_created
                    - token_consumed
                    - token_expired
                    - unbilled_charges_created
                    - unbilled_charges_voided
                    - unbilled_charges_deleted
                    - unbilled_charges_invoiced
                    - order_created
                    - order_updated
                    - order_cancelled
                    - order_delivered
                    - order_returned
                    - order_ready_to_process
                    - order_ready_to_ship
                    - order_deleted
                    - order_resent
                    - quote_created
                    - quote_updated
                    - quote_deleted
                    - tax_withheld_recorded
                    - tax_withheld_deleted
                    - tax_withheld_refunded
                    - gift_scheduled
                    - gift_unclaimed
                    - gift_claimed
                    - gift_expired
                    - gift_cancelled
                    - gift_updated
                    - hierarchy_created
                    - hierarchy_deleted
                    - payment_intent_created
                    - payment_intent_updated
                    - contract_term_created
                    - contract_term_renewed
                    - contract_term_terminated
                    - contract_term_completed
                    - contract_term_cancelled
                    - voucher_created
                    - voucher_expired
                    - voucher_create_failed
                    - subscription_ramp_created
                    - subscription_ramp_deleted
                    - subscription_ramp_applied
                    - subscription_ramp_drafted
                    - subscription_ramp_updated
                    - subscription_moved_in
                    - subscription_moved_out
                    - subscription_movement_failed
                    - omnichannel_subscription_created
                    - omnichannel_subscription_item_renewed
                    - omnichannel_subscription_item_downgraded
                    - omnichannel_subscription_item_expired
                    - omnichannel_subscription_item_cancellation_scheduled
                    - omnichannel_subscription_item_scheduled_cancellation_removed
                    - omnichannel_subscription_item_resubscribed
                    - omnichannel_subscription_item_upgraded
                    - omnichannel_subscription_item_cancelled
                    - omnichannel_subscription_imported
                    - omnichannel_subscription_item_grace_period_started
                    - omnichannel_subscription_item_grace_period_expired
                    - omnichannel_subscription_item_dunning_started
                    - omnichannel_subscription_item_dunning_expired
                    - rule_created
                    - rule_updated
                    - rule_deleted
                    - record_purchase_failed
                    - omnichannel_subscription_item_change_scheduled
                    - omnichannel_subscription_item_scheduled_change_removed
                    - omnichannel_subscription_item_reactivated
                    - sales_order_created
                    - sales_order_updated
                    - omnichannel_subscription_item_changed
                    - omnichannel_subscription_item_paused
                    - omnichannel_subscription_item_resumed
                    - omnichannel_one_time_order_created
                    - omnichannel_one_time_order_item_cancelled
                    - usage_file_ingested
                    - omnichannel_subscription_item_pause_scheduled
                    example: null
                  example: null
              required:
              - name
              - url
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_endpoint:
                    $ref: "#/components/schemas/WebhookEndpoint"
                    description: |-
                      <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook_endpoint</code>
                      resource object that contains the configuration and details of the created webhook.</p>
                required:
                - webhook_endpoint
                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: []
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
    "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
    "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. \* \`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
    "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
    "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
    "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
    "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
    "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
    "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
    AccountHolderType:
      type: string
      deprecated: false
      enum:
      - individual
      - company
      example: null
    AccountReceivablesHandling:
      type: string
      deprecated: false
      enum:
      - no_action
      - schedule_payment_collection
      - write_off
      example: null
    AccountType:
      type: string
      deprecated: false
      enum:
      - checking
      - savings
      - business_checking
      - current
      example: null
    Action:
      type: string
      deprecated: false
      enum:
      - upsert
      - remove
      example: null
    Addon:
      type: object
      additionalProperties: true
      description: |
        Addons are additional charges applied to a subscription apart from the base plan charge. The addons can be recurring or non-recurring. A recurring addon included in a subscription is charged as per billing frequency of subscription. A non-recurring addon included in subscription will be charged immediately and only once. And a non-recurring addon is NOT pro-rated based on billing cycle, whereas a recurring addon is automatically pro-rated based on billing cycle.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique ID for your system to identify the addon.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name used in web interface for identifying the addon.
          maxLength: 100
          example: null
        invoice_name:
          type: string
          deprecated: false
          description: |
            Display name used in invoice. If it is not configured then name is used in invoice.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description about the addon to show in the hosted pages \& customer portal. This description will not be shown if multiple addons are added.
            **Note:**

            If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
          maxLength: 2000
          example: null
        pricing_model:
          type: string
          deprecated: false
          description: |
            Defines how the charges for the addons are calculated.
            \* tiered -

            There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
            \* per_unit -

            A fixed price per unit quantity.
            \* flat_fee -

            A fixed price that is not quantity-based.
            \* volume -

            The per unit price is based on the tier that the total quantity falls in.
            \* stairstep -

            A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
          enum:
          - flat_fee
          - per_unit
          - tiered
          - volume
          - stairstep
          example: null
        charge_type:
          type: string
          default: recurring
          deprecated: false
          description: |
            Type of charge
            \* non_recurring -

            Charged immediately and only once every time it is applied.
            \* recurring -

            Charges are automatically applied in sync with the billing frequency of subscription.
          enum:
          - recurring
          - non_recurring
          example: null
        price:
          type: integer
          format: int64
          deprecated: false
          description: |
            Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).
            The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the addon
          maxLength: 3
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon
            \* month -

            Charge based on month(s)
            \* week -

            Charge based on week(s)
            \* not_applicable -

            not applicable for this addon
            \* year -

            Charge based on year(s)
            \* day -

            Charge based on Day(S)
          enum:
          - day
          - week
          - month
          - year
          - not_applicable
          example: null
        unit:
          type: string
          deprecated: false
          description: |
            Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.
            Applicable only for quantity type addons.
          maxLength: 30
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |
            Status of the addon
            \* archived -

            No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.
            \* active -

            Only active addons can be applied to subscriptions
            \* deleted -

            Indicates the addon has been deleted.
          enum:
          - active
          - archived
          - deleted
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time at which the plan was moved to archived status.
          example: null
        enabled_in_portal:
          type: boolean
          default: true
          deprecated: false
          description: |
            If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.
          example: null
        tax_code:
          type: string
          deprecated: false
          description: |
            The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
            .
          maxLength: 50
          example: null
        hsn_code:
          type: string
          deprecated: false
          description: |
            The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
            to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

            * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
            * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
          maxLength: 50
          example: null
        taxjar_product_code:
          type: string
          deprecated: false
          description: |
            The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
            .
          maxLength: 50
          example: null
        avalara_sale_type:
          type: string
          deprecated: false
          description: |
            Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
            \* retail -

            Transaction is a sale to an end user
            \* vendor_use -

            Transaction is for an item that is subject to vendor use tax
            \* wholesale -

            Transaction is a sale to another company that will resell your product or service to another consumer
            \* consumed -

            Transaction is for an item that is consumed directly
          enum:
          - wholesale
          - retail
          - consumed
          - vendor_use
          example: null
        avalara_transaction_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
          example: null
        avalara_service_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
          example: null
        sku:
          type: string
          deprecated: false
          description: |
            The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
          maxLength: 100
          example: null
        accounting_code:
          type: string
          deprecated: false
          description: |
            This field is to capture the Account code setup in your Accounting system for integration purposes only.
          maxLength: 100
          example: null
        accounting_category1:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category2:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category3:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.</li>
            </ul>
          maxLength: 100
          example: null
        accounting_category4:
          type: string
          deprecated: false
          description: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

            * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
            * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product.
          maxLength: 100
          example: null
        is_shippable:
          type: boolean
          default: false
          deprecated: false
          description: |
            If enabled, charges for this plan/addon will be added to orders.
          example: null
        shipping_frequency_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
          minimum: 1
          example: null
        shipping_frequency_period_unit:
          type: string
          deprecated: false
          description: |
            Defines the shipping frequency in association with shipping period.
            \* day -

            Ship based on day(s)
            \* week -

            Ship based on week(s)
            \* month -

            Ship based on month(s)
            \* year -

            Ship based on year(s)
          enum:
          - year
          - month
          - week
          - day
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this addon was last updated. This attribute will be present only if the resource has been updated after 2016-11-09.
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The price of the addon when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
            When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
            is enabled.</p>
            <p class="mb-2">This price is for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
            of the addon. When attached to a plan, the addon is billed for the billing period of the plan. <a href="https://www.chargebee.com/docs/addons-billingcycle.html " target="_blank">Learn more</a>
            is enabled.</p>
          maxLength: 39
          example: null
        included_in_mrr:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">The addon is included in MRR calculations for your site. This attribute is only applicable for addons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">charge_type = non_recurring</code>
            and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            .</p>
          example: null
        channel:
          type: string
          deprecated: false
          description: |
            The subscription channel this object originated from and is maintained in.
            \* app_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.
            \* web -

            The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
            \* play_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
          enum:
          - web
          - app_store
          - play_store
          example: null
        proration_type:
          type: string
          default: site_default
          deprecated: false
          description: |-
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
            Applicable only for addons with <code><a href="/docs/api/v2/pcv-1/addons/addon-object#pricing_model">pricing_model</a></code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p></div>
            <p class="mb-2">Specifies how to manage charges or credits for the addon during a <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">subscription update</a>
            or <a href="/docs/api/v2/pcv-1/estimates/update-subscription-estimate">estimating</a>
            a subscription update.</p>
            <span featureId="cb-addon-proration" isMicro="true"></span>
            * full_term - <p class="mb-2">Charge the full price of the addon item price or give the full credit. Don&#x27;t apply any proration.</p>
            * site_default - <p class="mb-2">Use the <a href="https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration setting</a>
            .</p>
            * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p>
          enum:
          - site_default
          - partial_term
          - full_term
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
            displayed on the invoice PDF.
          maxLength: 2000
          example: null
        taxable:
          type: boolean
          default: true
          deprecated: false
          description: |
            Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
            have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
          example: null
        tax_profile_id:
          type: string
          deprecated: false
          description: |
            Tax profile of the addon.
          maxLength: 50
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the addon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
        show_description_in_invoices:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
            should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).
            If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)
            ) after the change are affected; past invoices are not.
          example: null
        show_description_in_quotes:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)
            should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
            If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
          example: null
        tiers:
          type: array
          deprecated: false
          description: |
            List of tiers for this addon(applicable only if it is tiered/volume/stairtstep pricing
          items:
            type: object
            deprecated: false
            properties:
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |-
                  <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                  The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                  .</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - price
            - starting_unit
            example: null
          example: null
        tax_providers_fields:
          type: array
          deprecated: false
          description: |
            List of vendor specific tax related information.
          items:
            type: object
            deprecated: false
            properties:
              provider_name:
                type: string
                deprecated: false
                description: |
                  Name of the tax provider currently we support.
                maxLength: 50
                example: null
              field_id:
                type: string
                deprecated: false
                description: |
                  Field id of the attribute which tax vendor has provided while getting onboarded with us.
                maxLength: 50
                example: null
              field_value:
                type: string
                deprecated: false
                description: |
                  The value of the corresponding tax field.
                maxLength: 50
                example: null
            required:
            - field_id
            - field_value
            - provider_name
            example: null
          example: null
      required:
      - charge_type
      - currency_code
      - enabled_in_portal
      - id
      - name
      - period_unit
      - pricing_model
      - status
      example: null
    AddonCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            addon:
              $ref: "#/components/schemas/Addon"
          required:
          - addon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AddonDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            addon:
              $ref: "#/components/schemas/Addon"
          required:
          - addon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AddonUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            addon:
              $ref: "#/components/schemas/Addon"
          required:
          - addon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Address:
      type: object
      description: |
        Subscriptions can have addresses like "Shipping Address" associated with them. This is apart from the billing address as part of credit card information.
      properties:
        label:
          type: string
          deprecated: false
          description: |
            Label to identify the address. This is unique for all the address for a subscription.
          maxLength: 50
          example: null
        first_name:
          type: string
          deprecated: false
          description: |
            First name
          maxLength: 150
          example: null
        last_name:
          type: string
          deprecated: false
          description: |
            Last name
          maxLength: 150
          example: null
        email:
          type: string
          format: email
          deprecated: false
          description: |
            Email
          maxLength: 70
          example: null
        company:
          type: string
          deprecated: false
          description: |
            Company name
          maxLength: 250
          example: null
        phone:
          type: string
          deprecated: false
          description: |
            Phone number
          maxLength: 50
          example: null
        addr:
          type: string
          deprecated: false
          description: |
            Address line 1
          maxLength: 150
          example: null
        extended_addr:
          type: string
          deprecated: false
          description: |
            Address line 2
          maxLength: 150
          example: null
        extended_addr2:
          type: string
          deprecated: false
          description: |
            Address line 3
          maxLength: 150
          example: null
        city:
          type: string
          deprecated: false
          description: |
            Name of the city
          maxLength: 50
          example: null
        state_code:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
            without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
            ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
            ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
            ).</p>
          maxLength: 50
          example: null
        state:
          type: string
          deprecated: false
          description: |
            State or Province
          maxLength: 50
          example: null
        country:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
            .</p>
            <p class="mb-2"><strong class="font-semibold">Note</strong>:
            If you enter an invalid country code, the system will return an error.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
          maxLength: 50
          example: null
        zip:
          type: string
          deprecated: false
          description: |
            Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
            .
          maxLength: 20
          example: null
        validation_status:
          type: string
          default: not_validated
          deprecated: false
          description: |
            The address verification status.
            \* partially_valid -

            The address is valid for taxability but has not been validated for shipping.
            \* not_validated -

            Address is not yet validated.
            \* invalid -

            Address is invalid.
            \* valid -

            Address was validated successfully.
          enum:
          - not_validated
          - valid
          - partially_valid
          - invalid
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
          maxLength: 50
          example: null
      required:
      - label
      - subscription_id
      example: null
    AdvanceInvoiceSchedule:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">The invoice for a subscription in Chargebee is generated at the time of subscription renewal. Invoices can also be <a href="https://www.chargebee.com/docs/advance-invoices.html" target="_blank" rel="noopener noreferrer">generated in advance</a> for an upcoming renewal or set of renewals. With Advance Invoicing Schedules, you can set up a plan for when such advance invoices are generated for the lifetime of the subscription. This helps you:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Set up a contract with your customers so that they can be notified of their payment schedules in advance.</li>
        <li class="text-base leading-relaxed">Allow customers who make offline payments to be alerted about their upcoming dues well ahead of actual subscription renewals.</li>
        <li class="text-base leading-relaxed">Prevent post-renewal unpaid usage of your services by customers.</li>
        </ul><p class="mb-2">Advance invoices can be scheduled in two ways:</p><h4>Specific Dates Schedule</h4><p class="mb-2">Advance invoices for a subscription can be scheduled to be generated on specific <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_date">dates</a> in the future. You must specify the <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge">number of billing cycles</a> to be invoiced on each date. A maximum of 5 dates can be specified.</p><h4>Fixed Interval Schedule</h4><p class="mb-2">Advance invoices can be scheduled to be generated at fixed intervals of time, where each interval spans the same number of billing cycles of the subscription. The invoice for each interval is generated a specified number of days (<a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_days_before_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">days_before_interval</code></a>) before the start of the interval. You can configure the schedule to end on a certain date or after a specified number of advance invoices have been generated.</p><p class="mb-2">The start date of the first interval depends on the number of days remaining from current time till the next renewal of the subscription. If this is more than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">days_before_interval</code>, the interval begins at the next renewal. On the other hand, if the number of days remaining before the next renewal is less than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">days_before_interval</code>, the first interval begins at the renewal following the next.</p></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">System-generated and immutable unique Id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">advance_invoice_schedule</code>
            .</p>
          maxLength: 40
          example: null
        schedule_type:
          type: string
          deprecated: false
          description: |
            The type of advance invoice or advance invoicing schedule.
            \* specific_dates -

            The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge)
            is charged for. There can be up to 5 dates configured.
            \* fixed_intervals -

            The advance charges occur at [fixed intervals of time](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_terms_to_charge)
            .
          enum:
          - fixed_intervals
          - specific_dates
          example: null
        fixed_interval_schedule:
          type: object
          deprecated: false
          description: |-
            <p class="mb-2">When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_intervals</code>
            , this object gives further details of the schedule.</p>
          properties:
            end_schedule_on:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">Specifies when the schedule should end.</p>
                * after_number_of_intervals - <p class="mb-2">Advance invoices are generated a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specified number of times</code></p>
                * subscription_end - <p class="mb-2">Advance invoices are generated for as long as the subscription is active.</p>
                * specific_date - <p class="mb-2">End the advance invoicing schedule on a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific date</code>
                .</p>
              enum:
              - after_number_of_intervals
              - specific_date
              - subscription_end
              example: null
            number_of_occurrences:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the <a href="/docs/api/subscriptions/subscription-object#remaining_billing_cycles"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">remaining_billing_cycles</code></a>
                of the subscription.  This parameter is applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">after_number_of_intervals</code></p>
              minimum: 1
              example: null
            days_before_renewal:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of days before each interval that advance invoices are generated.
              minimum: 1
              example: null
            end_date:
              type: integer
              format: unix-time
              deprecated: false
              description: |-
                <p class="mb-2">The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_interval_schedule[end_schedule_on]</code></a>
                = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
                .</p>
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The date when this advance invoicing schedule was created.
              example: null
            terms_to_charge:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of billing cycles in one interval.
              minimum: 1
              example: null
          required:
          - created_at
          example: null
        specific_dates_schedule:
          type: object
          deprecated: false
          description: |
            The advance charges occur on specific dates. For each date, \[a fixed number of billing cycles\](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured.
          properties:
            terms_to_charge:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">The number of billing cycles to charge for, on the date specified. Applicable only when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                is specific_dates.</p>
              example: null
            date:
              type: integer
              format: unix-time
              deprecated: false
              description: |-
                <p class="mb-2">The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when <a href="/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code></a>
                is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_dates</code>
                .</p>
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The date when this advance invoicing schedule was created.
              example: null
          required:
          - created_at
          example: null
      required:
      - id
      example: null
    AlarmStatus:
      type: string
      deprecated: false
      enum:
      - within_limit
      - in_alarm
      example: null
    Amendment:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        event_id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - subscription_changed
          - subscription_created
          - subscription_cancelled
          - subscription_reactivated_with_backdating
          - subscription_activated_with_backdating
          - subscription_created_with_backdating
          - subscription_resumption_scheduled
          - subscription_scheduled_resumption_removed
          - subscription_canceled_with_backdating
          - subscription_changed_with_backdating
          - subscription_changes_scheduled
          - subscription_cancellation_scheduled
          - subscription_pause_scheduled
          - subscription_scheduled_changes_removed
          - subscription_scheduled_cancellation_removed
          - subscription_scheduled_pause_removed
          - subscription_reactivated
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - executed
          - scheduled
          - canceled
          example: null
        sequence_number:
          type: integer
          format: int32
          deprecated: false
          minimum: 1
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        effective_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        source:
          type: string
          deprecated: false
          enum:
          - admin_console
          - api
          - scheduled_job
          - hosted_page
          - portal
          - system
          - none
          - js_api
          - migration
          - bulk_operation
          - external_service
          example: null
        user:
          type: string
          deprecated: false
          maxLength: 150
          example: null
        api_key_name:
          type: string
          deprecated: false
          maxLength: 150
          example: null
      required:
      - created_at
      - effective_at
      - event_id
      - id
      - sequence_number
      - source
      - status
      - subscription_id
      - type
      example: null
    ApiVersion:
      type: string
      default: v1
      deprecated: false
      enum:
      - v1
      - v2
      example: null
    ApplyOn:
      type: string
      deprecated: false
      enum:
      - invoice_amount
      - specific_item_price
      example: null
    ApprovalEstimate:
      type: object
      properties:
        approval_required:
          type: boolean
          deprecated: false
          example: null
      required:
      - approval_required
      example: null
    AsyncJob:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - in_progress
          - completed
          - failed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        completed_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        request:
          type: object
          deprecated: false
          properties:
            resource:
              type: string
              deprecated: false
              maxLength: 100
              example: null
            action_type:
              type: string
              deprecated: false
              maxLength: 100
              example: null
          required:
          - action_type
          - resource
          example: null
        result:
          type: object
          deprecated: false
          properties:
            content:
              type: object
              additionalProperties: true
              deprecated: false
              example: null
            content_list:
              type: array
              deprecated: false
              items:
                example: null
              example: null
            error:
              type: object
              additionalProperties: true
              deprecated: false
              example: null
          example: null
      required:
      - created_at
      - id
      - request
      - status
      example: null
    AsyncRequest:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        resource:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        operation_type:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - enqueued
          - in_process
          - success
          - failed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        started_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        completed_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        result:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
        error_detail:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
      required:
      - created_at
      - error_detail
      - id
      - operation_type
      - resource
      - result
      - status
      - updated_at
      example: null
    AuthorizationSucceededEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
          required:
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AuthorizationVoidedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
          required:
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AutoCollection:
      type: string
      deprecated: false
      enum:
      - "on"
      - "off"
      example: null
    AvalaraSaleType:
      type: string
      deprecated: false
      enum:
      - wholesale
      - retail
      - consumed
      - vendor_use
      example: null
    BillingAlignmentMode:
      type: string
      deprecated: false
      enum:
      - immediate
      - delayed
      example: null
    BillingConfiguration:
      type: object
      properties:
        is_calendar_billing_enabled:
          type: boolean
          deprecated: false
          example: null
        billing_dates:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
            example: null
          example: null
      required:
      - is_calendar_billing_enabled
      example: null
    BillingDateMode:
      type: string
      deprecated: false
      enum:
      - using_defaults
      - manually_set
      example: null
    BillingDayOfWeekMode:
      type: string
      deprecated: false
      enum:
      - using_defaults
      - manually_set
      example: null
    BillingPeriodUnit:
      type: string
      deprecated: false
      enum:
      - day
      - week
      - month
      - year
      example: null
    Brand:
      type: object
      description: |
        The brand to which this offer belongs, including its unique id and human-readable name
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The ID of the brand to which these offers belong.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The name of the brand to which these offers belong.
          maxLength: 150
          example: null
      required:
      - id
      - name
      example: null
    BrandConfiguration:
      type: object
      properties:
        logo_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        scaled_logo_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        scaled_logo_width:
          type: integer
          format: int32
          deprecated: false
          example: null
        logo_size:
          type: string
          deprecated: false
          enum:
          - small
          - medium
          - large
          example: null
        icon_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        scaled_icon_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        scaled_icon_width:
          type: integer
          format: int32
          deprecated: false
          example: null
        icon_size:
          type: string
          deprecated: false
          enum:
          - small
          - medium
          - large
          example: null
        favicon_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        scaled_favicon_url:
          type: string
          deprecated: false
          maxLength: 300
          example: null
        color:
          type: string
          default: "#2196F3"
          deprecated: false
          maxLength: 7
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - modified_at
      example: null
    BrandStyle:
      type: object
      properties:
        handle:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        custom_domain:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        website_url:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        created_by:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        primary_color:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        assets:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        configuration:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
      required:
      - handle
      - name
      example: null
    CancelOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - end_of_term
      - specific_date
      - end_of_billing_term
      example: null
    Card:
      type: object
      description: "#### Deprecated\n\nThe [Payment Sources API](/docs/api/payment_sources)\n\
        , with its additional options and improvements, obsoletes the Cards APIs.\
        \ [Learn more](/docs/api/getting-started)\n.\n\nThe following table lists\
        \ the Payment Sources API operations alongside the equivalent Card API operations:\
        \  \n\n|                             API at Card resource                \
        \             |                                                          \
        \                                                                        \
        \       Use instead                                                      \
        \                                                                        \
        \           |\n|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | [Retrieve card for a customer](/docs/api/cards/retrieve-card-for-a-customer)\
        \ | [Retrieve a payment source](/docs/api/payment_sources/retrieve-a-payment-source)\
        \                                                                        \
        \                                                                        \
        \                                                            |\n| [Update\
        \ card for a customer](/docs/api/cards/update-card-for-a-customer)     | *\
        \ [Create using temporary token](/docs/api/v2/pcv-1/payment_sources/create-using-gateway-temporary-token)\
        \ * [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token)\
        \ * [Create a card payment source](/docs/api/payment_sources/create-a-card-payment-source)\
        \ |\n| [Switch gateway](/docs/api/cards/switch-gateway)                  \
        \           | [Switch gateway account](/docs/api/payment_sources/switch-gateway-account)\
        \                                                                        \
        \                                                                        \
        \                                                                  |\n| [Copy\
        \ card](/docs/api/cards/copy-card)                                       |\
        \ [Export payment source](/docs/api/payment_sources/export-payment-source)\
        \                                                                        \
        \                                                                        \
        \                                                                    |\n|\
        \ [Delete card for a customer](/docs/api/cards/delete-card-for-a-customer)\
        \     | [Delete a payment source](/docs/api/payment_sources/delete-a-payment-source)\
        \                                                                        \
        \                                                                        \
        \                                                                |\n\n"
      properties:
        payment_source_id:
          type: string
          deprecated: false
          description: |
            Identifier of the payment source
          maxLength: 40
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of the card.
            \* valid -

            A valid and active credit card
            \* expiring -

            A card which is expiring in the current month.
            \* expired -

            An expired card
          enum:
          - valid
          - expiring
          - expired
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Name of the gateway this payment source is stored with.\n\\\
            * twikey -\n\nTwikey is a payment service provider that specializes in\
            \ processing direct debit payments across the EU.\n\\* bluesnap -\n\n\
            BlueSnap is a payment gateway.\n\\* jp_morgan -\n\nJ.P. Morgan Mobility\
            \ Payment Solutions is a payment gateway that enables you to securely\
            \ accept and manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type).\
            \  \nThis feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature)\
            \ to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL\
            \ for your test and live sites.\n\\* tco -\n\n2Checkout is a payment gateway.\n\
            \\* deutsche_bank -\n\nDeutsche Bank is the leading German bank with strong\
            \ European roots and a global network.  \nThis feature is a **Private\
            \ Beta Release**.\n\\* bluepay -\n\nBluePay is a payment gateway.\n\\\
            * paypal_express_checkout -\n\nPayPal Express Checkout is a payment gateway.\n\
            \\* paypal_payflow_pro -\n\nPayPal Payflow Pro is a payment gateway.\n\
            \\* razorpay -\n\nRazorpay is a fast growing payment service provider\
            \ in India working with all leading banks and support for major local\
            \ payment methods including Netbanking, UPI etc.\n\\* global_payments\
            \ -\n\nGlobal Payments is a payment service provider.\n\\* dlocal -\n\n\
            Dlocal provides payment solutions for global commerce by accepting local\
            \ payment methods.\n\\* not_applicable -\n\nIndicates that payment gateway\
            \ is not applicable for this resource.\n\\* checkout_com -\n\nCheckout.com\
            \ is a payment gateway.\n\\* adyen -\n\nAdyen is a payment gateway.\n\\\
            * braintree -\n\nBraintree is a payment gateway.\n\\* nmi -\n\nNMI is\
            \ a payment gateway.\n\\* worldpay -\n\nWorldPay is a payment gateway\n\
            \\* paystack -\n\nPaystack is a payment gateway for businesses in Africa.\
            \ It enables secure payment acceptance both online and offline.  \nThis\
            \ feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
            \ to enable Paystack for your test and live sites.\n\\* pay_com -\n\n\
            Pay.com provides payment services focused on simplicity and hassle-free\
            \ operations for businesses of all sizes.\n\\* moneris_us -\n\nMoneris\
            \ USA is a payment gateway.\n\\* pin -\n\nPin is a payment gateway\n\\\
            * authorize_net -\n\nAuthorize.net is a payment gateway\n\\* stripe -\n\
            \nStripe is a payment gateway.\n\\* moneris -\n\nMoneris is a payment\
            \ gateway.\n\\* chargebee -\n\nChargebee test gateway.\n\\* cybersource\
            \ -\n\nCyberSource is a payment gateway.\n\\* ecentric -\n\nEcentric provides\
            \ a seamless payment processing service in South Africa specializing on\
            \ omnichannel capabilities.\n\\* first_data_global -\n\nFirst Data Global\
            \ Gateway Virtual Terminal Account\n\\* exact -\n\nExact Payments is a\
            \ payment gateway.\n\\* nuvei -\n\nNuvei is a secure and reliable payment\
            \ processing solution that allows you to accept payments from customers\
            \ and suitable for various types of businesses.  \nThis feature is a **Private\
            \ Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
            \ to enable Nuvei for your test and live sites.\n\\* eway -\n\neWAY Account\
            \ is a payment gateway.\n\\* metrics_global -\n\nMetrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            \\* amazon_payments -\n\nAmazon Payments is a payment service provider.\n\
            \\* windcave -\n\nWindcave provides an end to end payment processing solution\
            \ in ANZ and other leading global markets.\n\\* quickbooks -\n\nIntuit\
            \ QuickBooks Payments gateway\n\\* wepay -\n\nWePay is a payment gateway.\n\
            \\* ezidebit -\n\nEzidebit is a payment gateway integration based in Australia\
            \ that supports automated direct debit, BPAY, and card payments for businesses.\
            \  \nThis feature is a **Private Beta Release**.\n\\* wirecard -\n\nWireCard\
            \ Account is a payment service provider.\n\\* chargebee_payments -\n\n\
            Chargebee Payments gateway\n\\* sage_pay -\n\nSage Pay is a payment gateway.\n\
            \\* elavon -\n\nElavon Virtual Merchant is a payment solution.\n\\* paypal_pro\
            \ -\n\nPayPal Pro Account is a payment gateway.\n\\* orbital -\n\nChase\
            \ Paymentech(Orbital) is a payment gateway.\n\\* paypal -\n\nPayPal Commerce\
            \ is a payment gateway.\n\\* beanstream -\n\nBambora(formerly known as\
            \ Beanstream) is a payment gateway.\n\\* hdfc -\n\nHDFC Account is a payment\
            \ gateway.\n\\* ingenico_direct -\n\nWorldline Online Payments is a payment\
            \ gateway.\n\\* ogone -\n\nIngenico ePayments (formerly known as Ogone)\
            \ is a payment gateway.\n\\* migs -\n\nMasterCard Internet Gateway Service\
            \ payment gateway.\n\\* vantiv -\n\nVantiv is a payment gateway.\n\\*\
            \ bank_of_america -\n\nBank of America Gateway\n\\* eway_rapid -\n\neWAY\
            \ Rapid is a payment gateway.\n\\* gocardless -\n\nGoCardless is a payment\
            \ service provider.\n\\* mollie -\n\nMollie is a payment gateway.\n\\\
            * paymill -\n\nPAYMILL is a payment gateway.\n\\* balanced_payments -\n\
            \nBalanced is a payment gateway\n\\* solidgate -\n\nSolidgate is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \nThis\
            \ feature is a **Private Beta Release**.\n\\* ebanx -\n\nEBANX is a payment\
            \ gateway, enabling businesses to accept diverse local payment methods\
            \ from various countries for increased market reach and conversion.\n"
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account to which this payment source is stored with.
          maxLength: 50
          example: null
        ref_tx_id:
          type: string
          deprecated: false
          description: |
            Reference transaction id which used for transactions
          maxLength: 50
          example: null
        first_name:
          type: string
          deprecated: false
          description: |
            Cardholder's first name
          maxLength: 50
          example: null
        last_name:
          type: string
          deprecated: false
          description: |
            Cardholder's last name
          maxLength: 50
          example: null
        iin:
          type: string
          deprecated: false
          description: |
            The Issuer Identification Number, i.e. the first six digits of the card number
          maxLength: 6
          minLength: 6
          example: null
        last4:
          type: string
          deprecated: false
          description: |
            Last four digits of the card number
          maxLength: 4
          minLength: 4
          example: null
        card_type:
          type: string
          deprecated: false
          description: |
            Card type
            \* cabal -

            A Cabal card.
            \* hipercard -

            An Hipercard.
            \* dankort -

            A Dankort card.
            \* bancontact -

            A Bancontact card.
            \* american_express -

            An American Express card.
            \* maestro -

            A Maestro card.
            \* mada -

            A Mada card.
            \* nativa -

            A Nativa card.
            \* cmr_falabella -

            A CMR Falabella card.
            \* not_applicable -

            Used for offline entries in transactions. Not applicable for cards
            \* elo -

            A Elo card.
            \* diners_club -

            A Diner's Club card.
            \* discover -

            A Discover card.
            \* other -

            Card belonging to types other than those listed above.
            \* mastercard -

            A MasterCard.
            \* jcb -

            A JCB card.
            \* cartes_bancaires -

            A Cartes Bancaires card.
            \* argencard -

            An Argencard.
            \* cencosud -

            A Cencosud card.
            \* tarjeta_naranja -

            A Tarjeta Naranja card.
            \* visa -

            A Visa card.
            \* carnet -

            A Carnet card.
            \* rupay -

            A Rupay card.
          enum:
          - visa
          - mastercard
          - american_express
          - discover
          - jcb
          - diners_club
          - bancontact
          - cmr_falabella
          - tarjeta_naranja
          - nativa
          - cencosud
          - cabal
          - argencard
          - elo
          - hipercard
          - carnet
          - rupay
          - maestro
          - dankort
          - cartes_bancaires
          - mada
          - other
          - not_applicable
          example: null
        funding_type:
          type: string
          deprecated: false
          description: |
            Card Funding type
            \* credit -

            A credit card.
            \* prepaid -

            A prepaid card.
            \* debit -

            A debit card.
            \* not_applicable -

            Used for ACH. Not applicable for cards
            \* not_known -

            An unknown card.
          enum:
          - credit
          - debit
          - prepaid
          - not_known
          - not_applicable
          example: null
        expiry_month:
          type: integer
          format: int32
          deprecated: false
          description: |
            Card expiry month.
          maximum: 12
          minimum: 1
          example: null
        expiry_year:
          type: integer
          format: int32
          deprecated: false
          description: |
            Card expiry year.
          example: null
        issuing_country:
          type: string
          deprecated: false
          description: |
            [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)
            ISO country code.
          maxLength: 50
          example: null
        billing_addr1:
          type: string
          deprecated: false
          description: |
            Address line 1, as available in card billing address.
          maxLength: 150
          example: null
        billing_addr2:
          type: string
          deprecated: false
          description: |
            Address line 2, as available in card billing address.
          maxLength: 150
          example: null
        billing_city:
          type: string
          deprecated: false
          description: |
            City, as available in card billing address.
          maxLength: 50
          example: null
        billing_state_code:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
            without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
            ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
            ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
            (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
            ).</p>
          maxLength: 50
          example: null
        billing_state:
          type: string
          deprecated: false
          description: |
            The state/province name.
          maxLength: 50
          example: null
        billing_country:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
            .</p>
            <p class="mb-2"><strong class="font-semibold">Note</strong>:
            If you enter an invalid country code, the system will return an error.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
          maxLength: 50
          example: null
        billing_zip:
          type: string
          deprecated: false
          description: |
            Postal or Zip code, as available in card billing address.
          maxLength: 20
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this card resource is created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this credit card resource was last updated.
          example: null
        ip_address:
          type: string
          deprecated: false
          description: |
            The IP address of the customer. Used primarily for referral integration and EU VAT validation.
          maxLength: 50
          example: null
        powered_by:
          type: string
          deprecated: false
          description: |
            Card powered by payment method.
            \* card -

            card
            \* ideal -

            ideal
            \* payconiq -

            payconiq
            \* sofort -

            sofort
            \* bancontact -

            bancontact
            \* giropay -

            giropay
            \* latam_local_card -

            latam_local_card
            \* not_applicable -

            not_applicable
          enum:
          - ideal
          - sofort
          - bancontact
          - giropay
          - card
          - latam_local_card
          - payconiq
          - not_applicable
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        masked_number:
          type: string
          deprecated: false
          description: |
            Masked credit card number that is safe to show.
          maxLength: 19
          example: null
      required:
      - created_at
      - customer_id
      - expiry_month
      - expiry_year
      - funding_type
      - gateway
      - iin
      - last4
      - payment_source_id
      - status
      example: null
    CardAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CardDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CardExpiredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CardExpiryReminderEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CardUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Category:
      type: string
      deprecated: false
      enum:
      - introductory
      - promotional
      - developer_determined
      example: null
    ChangeOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - end_of_term
      - specific_date
      example: null
    Channel:
      type: string
      deprecated: false
      enum:
      - web
      - app_store
      - play_store
      example: null
    ChargeModel:
      type: string
      deprecated: true
      enum:
      - full_charge
      - prorate
      example: null
    ChargeOn:
      type: string
      deprecated: false
      enum:
      - immediately
      - on_event
      example: null
    ChargeOnEvent:
      type: string
      deprecated: false
      enum:
      - subscription_creation
      - subscription_trial_start
      - plan_activation
      - subscription_activation
      - contract_termination
      - on_demand
      example: null
    ChargeOnOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - on_event
      example: null
    ChargebeeResponseSchemaType:
      type: string
      deprecated: false
      enum:
      - plans_addons
      - items
      - compat
      example: null
    ChargesHandling:
      type: string
      deprecated: false
      enum:
      - invoice_immediately
      - add_to_unbilled_charges
      example: null
    Comment:
      type: object
      description: |
        Comments are additional information that you can add to your resources. Comments can be added to provide context for any operation that was performed.

        When you make an API call on any resource eg., Subscriptions -\> Change term end, you can add more context to that operation by calling the comments API as a follow up call.

        Besides the user generated comments, Chargebee also generates "System" comments when a change for a resource happens at the backend. These comments are all read-only.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier for the comment.
          maxLength: 40
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Type of the entity this comment generated for
            \* item -

            Entity that represents item
            \* invoice -

            Invoice description
            \* product -

            Entity that represents product
            \* plan -

            Entity that represents a subscription plan
            \* item_family -

            Entity that represents item family
            \* transaction -

            Entity that represents a transaction.
            \* quote -

            Entity that represents a quote
            \* order -

            Entity that represents an order
            \* item_price -

            Entity that represents item price
            \* customer -

            Entity that represents a customer
            \* variant -

            Entity that represents product variants
            \* business_entity -

            Entity that represents item of type business entity
            \* coupon -

            Entity that represents a discount coupon
            \* subscription -

            Entity that represents a subscription of a customer
            \* addon -

            Entity that represents an addon
            \* credit_note -

            Credit note description
          enum:
          - customer
          - subscription
          - invoice
          - quote
          - credit_note
          - transaction
          - plan
          - addon
          - coupon
          - order
          - business_entity
          example: null
        added_by:
          type: string
          deprecated: false
          description: |
            The user who created the comment. If created via API, this contains the name given for the API key used.
          maxLength: 100
          example: null
        notes:
          type: string
          deprecated: false
          description: |
            Actual notes for the comment.
          maxLength: 1000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this comment was created
          example: null
        type:
          type: string
          default: user
          deprecated: false
          description: |
            Type of comment this is.
            \* system -

            Comment generated by Chargebee when any backend changes happen for an entity
            \* user -

            Comment generated by user either via API or Admin console.
          enum:
          - user
          - system
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the entity.
          maxLength: 100
          example: null
        business_entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - id
      - notes
      - type
      example: null
    Configuration:
      type: object
      description: |
        This resource returns your domain and product catalog version details - [Product Catalog 1.0](https://www.chargebee.com/docs/1.0/product-catalog.html)
        (v1) and [Product Catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)
        (v2).
      properties:
        domain:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The Chargebee <a href="https://www.chargebee.com/docs/2.0/sites-intro.html">site</a>
            for which the information has been requested. It is the same as the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{site}</code>
            provided as a path parameter.</p>
          maxLength: 50
          example: null
        product_catalog_version:
          type: string
          deprecated: false
          description: |
            The Product Catalog version of the site
            \* v2 -

            Indicates Product Catalog 2.0
            \* v1 -

            Indicates Product Catalog 1.0
          enum:
          - v1
          - v2
          example: null
        chargebee_response_schema_type:
          type: string
          deprecated: false
          description: |
            Specifies the API response format based on the product catalog version of the site.
            \* compat -

            The response supports both Product Catalog 1.0 and 2.0 formats. It is applicable only to sites that have been automatically upgraded to Product Catalog 2.0.
            \* items -

            The response format follows [product catalog 2.0](https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog)
            , using [items](/docs/api/items)
            .
            \* plans_addons -

            The response format follows [product catalog 1.0](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog)
            , using [plans](/docs/api/v2/pcv-1/plans)
            and [addons](/docs/api/v2/pcv-1/addons)
            .
          enum:
          - plans_addons
          - items
          - compat
          example: null
      example: null
    Contact:
      type: object
      description: |
        Contacts are the list of persons/organizations to whom billing and accounting emails will be sent.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique reference ID provided for the contact.
          maxLength: 150
          example: null
        first_name:
          type: string
          deprecated: false
          description: |
            First name of the contact.
          maxLength: 150
          example: null
        last_name:
          type: string
          deprecated: false
          description: |
            Last name of the contact.
          maxLength: 150
          example: null
        email:
          type: string
          format: email
          deprecated: false
          description: |
            Email of the contact.
          maxLength: 70
          example: null
        phone:
          type: string
          deprecated: false
          description: |
            Phone number of the contact.
          maxLength: 50
          example: null
        label:
          type: string
          deprecated: false
          description: |
            Label/Tag provided for contact.
          maxLength: 50
          example: null
        enabled:
          type: boolean
          default: false
          deprecated: false
          description: |
            Contact enabled / disabled
          example: null
        send_account_email:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether Account Emails option is enabled for the contact.
          example: null
        send_billing_email:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether Billing Emails option is enabled for the contact.
          example: null
      required:
      - email
      - enabled
      - id
      - send_account_email
      - send_billing_email
      example: null
    ContractTerm:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">Subscriptions can run indefinitely or they may run for a fixed number of billing cycles. Subscription can have &quot;contract terms&quot;, which define a lock-in period on the subscription for a certain number of billing cycles. This prevents the subscription from being canceled by the customer when it is within the contract term.</p><p class="mb-2">The <strong class="font-semibold">contract term</strong> resource described below defines the properties of this lock-in period. This includes the <a href="/docs/api/v2/pcv-1/contract_terms/contract_term-object#remaining_billing_cycles">number of billing cycles</a>, the <a href="/docs/api/v2/pcv-1/contract_terms/contract_term-object#total_contract_value">total contract value</a>, the <a href="/docs/api/v2/pcv-1/contract_terms/contract_term-object#action_at_term_end">action to be taken</a> at the end of the contract term, and so on. To allow for exceptions, you also have the option of terminating an <a href="/docs/api/v2/pcv-1/contract_terms/contract_term-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code></a> contract term and charging a <a href="/docs/api/v2/pcv-1/contract_terms">termination fee</a>.</p><p class="mb-2">A contract term starts in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> state and ends in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">completed</code> state. If the contract was canceled due to non-payment or other reasons, it can end in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">canceled</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terminated</code> state. A given contract term is always associated with one, and only one subscription. A subscription, however, can be associated with only one <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> contract term. Over time, a subscription can be associated with several non-<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> contract terms. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> contract term for a subscription is available as an <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#contract_term">object</a> within the subscription.</p><p class="mb-2">To enable and configure contract terms, follow these steps in the Chargebee UI:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Click <strong class="font-semibold">Settings</strong> on the left navigation.</li>
        <li class="text-base leading-relaxed">Click <strong class="font-semibold">Configure Chargebee</strong>.</li>
        <li class="text-base leading-relaxed">Under <strong class="font-semibold">Billing</strong>, click <strong class="font-semibold">Contract Terms</strong>.</li>
        <li class="text-base leading-relaxed">Enable and configure the feature as needed.</li>
        </ol><p class="mb-2">Once contract terms have been configured, the following actions can be performed using the API:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2"><strong class="font-semibold">Define a contract term</strong> for a subscription and <strong class="font-semibold">set renewal options</strong> for the contract term. The following endpoints support this:</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/create-a-subscription">Create a subscription</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer">Create subscription for customer</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">Update a subscription</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/reactivate-a-subscription">Reactivate a subscription</a>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><strong class="font-semibold">Retrieving</strong> a historical record of all contract terms for a subscription can be done via the following endpoint:</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/list-contract-terms-for-a-subscription">List contract terms for a subscription</a>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2"><strong class="font-semibold">Canceling a contract term</strong> can be done via the following endpoints:</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">Update a subscription</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription">Cancel a subscription</a>
        </li>
        </ul><h4>Including a termination fee</h4><p class="mb-2">When a contract is canceled mid-term, you can set a termination fee to be levied. Here&#x27;s how:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="/docs/api/v2/pcv-1/addons/create-an-addon#charge_type">Create the termination fee as a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_recurring</code> addon</a>.</li>
        <li class="text-base leading-relaxed"><a href="/docs/api/v2/pcv-1/plans/plan-object#event_based_addons">Associate this addon with a plan</a> or <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object#event_based_addons">include the addon to a subscription</a>. In either case, set the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">event_based_addons[on_event]</code> parameter to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_term_termination</code>.</li>
        </ol><p class="mb-2">Once the above steps are done, the termination fee will be charged automatically if you <a href="/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#contract_term_cancel_option">terminate the contract in the middle of its term</a>.</p></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Id that uniquely identifies the contract term in the site.
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of contract
            \* active -

            An actively running contract term.
            \* cancelled -

            The contract term was ended because: - a change in the subscription caused a [subscription term reset](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#force_term_reset).

            * the subscription was cancelled due to non-payment.

            \* terminated -

            The contract term was terminated ahead of completion.
            \* completed -

            The contract term has run its full duration.
          enum:
          - active
          - completed
          - cancelled
          - terminated
          example: null
        contract_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The start date of the contract term
          example: null
        contract_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The end date of the contract term
          example: null
        billing_cycle:
          type: integer
          format: int32
          deprecated: false
          description: |
            The number of billing cycles of the subscription that the contract term is for.
          minimum: 0
          example: null
        action_at_term_end:
          type: string
          default: renew
          deprecated: false
          description: |-
            <p class="mb-2">Action to be taken when the contract term completes.</p>
            * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
            <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
            </ul>
            * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
            * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
            </ul>
            * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
          enum:
          - renew
          - evergreen
          - cancel
          - renew_once
          example: null
        total_contract_value:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |-
            <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
            of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
            contract terms, this is a predicted value. The value depends on the <a href="/docs/api/v2/pcv-1/contract_terms">type of currency</a>.
            If the subscription was <a href="/docs/api/v2/pcv-1/contract_terms">imported</a>
            with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
            .</p>
          minimum: 0
          example: null
        total_contract_value_before_tax:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        cancellation_cutoff_period:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
            , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date when the contract term was created.
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The [Id](/docs/api/subscriptions/subscription-object#id)
            of the subscription that this contract term is for.
          maxLength: 50
          example: null
        remaining_billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
            contract terms.</p>
          minimum: 0
          example: null
      required:
      - action_at_term_end
      - billing_cycle
      - contract_end
      - contract_start
      - created_at
      - id
      - status
      - subscription_id
      - total_contract_value
      - total_contract_value_before_tax
      example: null
    ContractTermCancelOption:
      type: string
      deprecated: false
      enum:
      - terminate_immediately
      - end_of_contract_term
      - specific_date
      - end_of_subscription_billing_term
      example: null
    ContractTermCancelledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            contract_term:
              $ref: "#/components/schemas/ContractTerm"
          required:
          - contract_term
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ContractTermCompletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            contract_term:
              $ref: "#/components/schemas/ContractTerm"
          required:
          - contract_term
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ContractTermCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            contract_term:
              $ref: "#/components/schemas/ContractTerm"
          required:
          - contract_term
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ContractTermRenewedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            contract_term:
              $ref: "#/components/schemas/ContractTerm"
          required:
          - contract_term
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ContractTermTerminatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            contract_term:
              $ref: "#/components/schemas/ContractTerm"
          required:
          - contract_term
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Coupon:
      type: object
      additionalProperties: true
      description: |-
        <div class="api-description"><h2>Overview</h2><p class="mb-2">Coupons are deductions applied to invoices or invoice line items. They&#x27;re designed to be consumed by your customers directly. A coupon deduction can either be for a fixed amount or for a percentage of the amount of the invoice or line item.</p><h2>Order of application of coupons</h2><p class="mb-2">When multiple <a href="/docs/api/coupons">coupons</a> are applied to a <a href="/docs/api/subscriptions">subscription</a> or <a href="/docs/api/v2/pcv-1/invoices/create-an-invoice">one-time invoice</a>, they&#x27;re applied in the following order:</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><tbody><tr><td class="ak-renderer-table-number-column"></td><th class="ak-renderer-tableHeader-sortable-column" colSpan="1" rowspan="1"><strong class="font-semibold">Summary</strong></th><th class="ak-renderer-tableHeader-sortable-column" colSpan="1" rowspan="1"><strong class="font-semibold">Description</strong></th></tr><tr><td class="ak-renderer-table-number-column">1</td><td colSpan="1" rowspan="1">Line-level, fixed amount coupons</td><td colSpan="1" rowspan="1"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">each_specified_item</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discount_type</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat</code></td></tr><tr><td class="ak-renderer-table-number-column">2</td><td colSpan="1" rowspan="1">Line-level, percentage coupons</td><td colSpan="1" rowspan="1"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">each_specified_item</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discount_type</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">percentage</code></td></tr><tr><td class="ak-renderer-table-number-column">3</td><td colSpan="1" rowspan="1">Invoice-level, fixed amount coupons</td><td colSpan="1" rowspan="1"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_amount</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discount_type</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat</code></td></tr><tr><td class="ak-renderer-table-number-column">4</td><td colSpan="1" rowspan="1">Invoice-level, percentage coupons</td><td colSpan="1" rowspan="1"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">apply_on</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_amount</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discount_type</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">percentage</code></td></tr></tbody></table></div><p class="mb-2">For example, consider the following scenario:</p><p class="mb-2">A subscription is created with:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">a plan price of $200 per month</li>
        <li class="text-base leading-relaxed">an addon price of $20 per month</li>
        <li class="text-base leading-relaxed">a flat $5 coupon on the invoice</li>
        <li class="text-base leading-relaxed">a 1% off coupon on the addon</li>
        <li class="text-base leading-relaxed">a flat $10 coupon on the plan</li>
        </ul><p class="mb-2">The above coupons are applied in the following order:</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><tbody><tr><td class="ak-renderer-table-number-column"></td><th class="ak-renderer-tableHeader-sortable-column" colSpan="1" rowspan="1"><strong class="font-semibold">Discount or coupon applied</strong></th><th class="ak-renderer-tableHeader-sortable-column" colSpan="1" rowspan="1"><strong class="font-semibold">Subtotal at each step</strong></th></tr><tr><td class="ak-renderer-table-number-column">1</td><td colSpan="1" rowspan="1">Initial subtotal (plan price + addon price)</td><td colSpan="1" rowspan="1">$200 + $20 = $220</td></tr><tr><td class="ak-renderer-table-number-column">2</td><td colSpan="1" rowspan="1">Flat $10 coupon on the plan</td><td colSpan="1" rowspan="1">$(200 - 10) + $20 = $190 + $20 = $210</td></tr><tr><td class="ak-renderer-table-number-column">3</td><td colSpan="1" rowspan="1">1% off coupon on the addon</td><td colSpan="1" rowspan="1">$190 + $(20 - 0.2) = $190 + $19.8 = $209.8</td></tr><tr><td class="ak-renderer-table-number-column">4</td><td colSpan="1" rowspan="1">Flat $5 coupon on the invoice</td><td colSpan="1" rowspan="1">$209.8 - $5 = <strong class="font-semibold">$204.8</strong></td></tr></tbody></table></div></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the coupon ID contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the coupon ID in the path parameter before making an API call.</p></div>
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The display name used in web interface for identifying the coupon.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">When the name of the coupon set contains a special character; for example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">#</code>, the API returns an error. Make sure that you <a href="https://www.urlencoder.org/">encode</a> the name of the coupon set in the path parameter before making an API call.</p></div>
          maxLength: 50
          example: null
        invoice_name:
          type: string
          deprecated: false
          description: |
            Display name used in invoice. If it is not configured then name is used in invoice.
          maxLength: 100
          example: null
        discount_type:
          type: string
          default: percentage
          deprecated: false
          description: |-
            <p class="mb-2">Specifies the type of discount to be applied.</p>
            * percentage - <p class="mb-2">A percentage of the original price is deducted as a discount. The discount percentage is specified in <code><a href="/docs/api/v2/pcv-1/coupons/coupon-object#discount_percentage">discount_percentage</a></code>.</p>
            <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#percentage">Learn more</a>
            about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">percentage</code>
            coupons.</p></div>
            * fixed_amount - <p class="mb-2">A fixed amount is deducted as a discount. The discount amount is specified in <code><a href="/docs/api/v2/pcv-1/coupons/coupon-object#discount_amount">discount_amount</a></code>.</p>
            <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount">Learn more</a>
            about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_amount</code>
            coupons.</p></div>
            * offer_quantity - <p class="mb-2">A specified number of units of the plan or addon are offered for free. The number of free units is specified in <code><a href="/docs/api/v2/pcv-1/coupons/coupon-object#discount_quantity">discount_quantity</a></code>.
            The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
            option is valid only when <code><a href="/docs/api/v2/pcv-1/coupons/coupon-object#apply_on">apply_on</a></code>
            is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">each_specified_item</code>
            and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
            of the <a href="/docs/api/v2/pcv-1/plans/plan-object#pricing_model">plan</a>
            or addon is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>.</p>
            <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity">Learn more</a>
            about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
            coupons.</p></div>
          enum:
          - fixed_amount
          - percentage
          - offer_quantity
          example: null
        discount_percentage:
          type: number
          format: double
          deprecated: false
          description: |
            The percentage of the original amount that should be deducted from it.
          maximum: 100
          minimum: 0.01
          example: null
        discount_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The value of the deduction. The format of this value depends on the [kind of currency](/docs/api/currencies)
            .
          minimum: 0
          example: null
        discount_quantity:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">Specifies the number of free units provided for the <a href="/docs/api/v2/pcv-1/plans">plan</a>
            or <a href="/docs/api/v2/pcv-1/addons">addon</a>
            , without affecting the total quantity sold. This parameter is applicable only when the <code><a href="/docs/api/v2/pcv-1/coupons/coupon-object#discount_type">discount_type</a></code>
            is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offer_quantity</code>
            .</p>
          minimum: 1
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
            ) of the coupon. Applicable for *fixed_amount*
            coupons alone.
          maxLength: 3
          example: null
        duration_type:
          type: string
          default: forever
          deprecated: false
          description: |-
            <p class="mb-2">Specifies the time duration for which this coupon is attached to the subscription.</p>
            * forever - <p class="mb-2">The coupon is attached to the subscription and applied on the invoices until explicitly removed.</p>
            * one_time - <p class="mb-2">The coupon stays attached to the subscription till it is applied on an invoice <strong class="font-semibold">once</strong>.
            It is removed after that from the subscription.</p>
            * limited_period - <p class="mb-2">The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
            .</p>
          enum:
          - one_time
          - forever
          - limited_period
          example: null
        valid_till:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Date upto which the coupon can be applied to new subscriptions.
          example: null
        max_redemptions:
          type: integer
          format: int32
          deprecated: false
          description: "Maximum number of times this coupon can be redeemed.  \n**Note:**\n\
            \nIf not specified, the coupon can be redeemed an indefinite number of\
            \ times.\n"
          minimum: 1
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |-
            <p class="mb-2">Status of the coupon.</p>
            * expired - <p class="mb-2">Cannot be applied to a subscription. A coupon may expire due to  exceeding <code><a href="/docs/api/coupons/coupon-object#max_redemptions">max_redemptions</a></code>
            or <code><a href="/docs/api/coupons/coupon-object#valid_till">valid_till</a></code>
            date is past. Existing associations remain unaffected.</p>
            * archived - <p class="mb-2">Cannot be applied to a subscription. Existing associations remain unaffected.</p>
            * active - <p class="mb-2">Can be applied to a subscription.</p>
            * deleted - <p class="mb-2">Indicates the coupon has been deleted.</p>
          enum:
          - active
          - expired
          - archived
          - deleted
          example: null
        apply_on:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The amount on the invoice to which the coupon is applied.</p>
            * invoice_amount - <p class="mb-2">The coupon is applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>
            .</p>
            * each_specified_item - <p class="mb-2">The coupon is applied to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.line_item.amount</code>
            that corresponds to the plan or addon specified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_ids</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon_ids</code>
            .</p>
          enum:
          - invoice_amount
          - each_specified_item
          example: null
        plan_constraint:
          type: string
          deprecated: false
          description: |
            Plans the coupon can be applied to.
            \* specific -

            Coupon applicable to specific plan(s).
            \* not_applicable -

            Coupon only applicable to invoice amount and not any plans.
            \* none -

            Coupon not applicable to any plans.
            \* all -

            Coupon applicable to all plans.
          enum:
          - none
          - all
          - specific
          - not_applicable
          example: null
        addon_constraint:
          type: string
          deprecated: false
          description: |
            Addons the coupon can be applied to.
            \* none -

            Coupon not applicable to any addons.
            \* not_applicable -

            Coupon only applicable to invoice amount and not any addons.
            \* specific -

            Coupon applicable to specific addon(s).
            \* all -

            Coupon applicable to all addons.
          enum:
          - none
          - all
          - specific
          - not_applicable
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this coupon is created.
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this coupon was archived.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The version number of this resource. For every change made to the resource, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Timestamp indicating when this coupon was last updated.
            Note that this does not change when the <code><a href="/docs/api/coupons/coupon-object#redemptions">redemptions</a></code>
            attribute is changed. This attribute will be present only if the resource has been updated after 2016-11-09.</p>
          example: null
        included_in_mrr:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type = one_time</code>
            and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            .</p>
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">The duration of time for which the coupon is attached to the subscription, in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_units</code>.
            Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
            is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
            .</p>
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The unit of time for period. Applicable only when <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</a></code>
            is <code><a href="/docs/api/coupons/coupon-object#duration_type">limited_period</a></code>
            .</p>
            * month - <p class="mb-2">A period of 1 calendar month.</p>
            * week - <p class="mb-2">A period of 7 days.</p>
            * year - <p class="mb-2">A period of 1 calendar year.</p>
            * day - <p class="mb-2">A period of 24 hours.</p>
          enum:
          - day
          - week
          - month
          - year
          example: null
        plan_ids:
          type: array
          deprecated: false
          description: |
            List of plan ids for which this coupon is applicable.
          items:
            type: string
            deprecated: false
            maxLength: 100
            example: null
          example: null
        addon_ids:
          type: array
          deprecated: false
          description: |
            List of addon ids for which this coupon is applicable.
          items:
            type: string
            deprecated: false
            maxLength: 100
            example: null
          example: null
        redemptions:
          type: integer
          format: int32
          deprecated: false
          description: |
            The number of times this coupon has been redeemed.
          minimum: 0
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
            displayed on the invoice PDF.
          maxLength: 2000
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the coupon. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
        deleted:
          type: boolean
          deprecated: false
          example: null
      required:
      - addon_constraint
      - apply_on
      - created_at
      - deleted
      - discount_type
      - duration_type
      - id
      - name
      - plan_constraint
      example: null
    CouponCode:
      type: object
      description: |
        Coupon codes are used along with existing coupons in Chargebee. You can create a coupon set using a bunch of coupon codes and this coupon set will be associated with an existing coupon. A coupon code can only be applied to a single subscription and cannot be re-used.

        Using coupon codes you can distribute several unique codes for a single main coupon, when you are running promotions.
      properties:
        code:
          type: string
          deprecated: false
          description: |
            Unique coupon code that can be redeemed only once.
          maxLength: 50
          example: null
        status:
          type: string
          default: not_redeemed
          deprecated: false
          description: |
            Status of the coupon code.
            \* not_redeemed -

            Can be applied to a subscription.
            \* redeemed -

            Cannot be applied to a subscription as the coupon code has been already used.
            \* archived -

            Cannot be applied to a subscription as it has been made inactive.
          enum:
          - not_redeemed
          - redeemed
          - archived
          example: null
        coupon_id:
          type: string
          deprecated: false
          description: |
            Id of the main coupon resource.
          maxLength: 100
          example: null
        coupon_set_id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies a coupon_set
          maxLength: 50
          example: null
        coupon_set_name:
          type: string
          deprecated: false
          description: |
            Coupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.
          maxLength: 50
          example: null
      required:
      - code
      - coupon_id
      - coupon_set_id
      - coupon_set_name
      - status
      example: null
    CouponCodesAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
          required:
          - coupon
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponCodesDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
            coupon_code:
              $ref: "#/components/schemas/CouponCode"
          required:
          - coupon
          - coupon_code
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponCodesUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
          required:
          - coupon
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
          required:
          - coupon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
          required:
          - coupon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponSet:
      type: object
      description: |
        A coupon set contains a bunch of coupon codes that can be redeemed by your customers when they are checking out. It belongs to an existing coupon and will usually be combined with other coupons that share similar promotion or discount offers. Using this resource, you can create, update, retrieve, delete coupon sets and add coupon codes to a coupon set.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies a coupon_set
          maxLength: 50
          example: null
        coupon_id:
          type: string
          deprecated: false
          description: |
            Coupon id linked to coupon set
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            Name of the coupon set
          maxLength: 50
          example: null
        total_count:
          type: integer
          format: int32
          deprecated: false
          description: |
            No of coupon codes present in coupon set
          example: null
        redeemed_count:
          type: integer
          format: int32
          deprecated: false
          description: |
            No of redeemed codes
          example: null
        archived_count:
          type: integer
          format: int32
          deprecated: false
          description: |
            No of archived codes
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the coupon set. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
      required:
      - coupon_id
      - id
      - name
      example: null
    CouponSetCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
          required:
          - coupon
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponSetDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
          required:
          - coupon
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponSetUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
            coupon_set:
              $ref: "#/components/schemas/CouponSet"
          required:
          - coupon
          - coupon_set
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CouponUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            coupon:
              $ref: "#/components/schemas/Coupon"
          required:
          - coupon
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CpqQuoteSignature:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        status:
          type: string
          default: draft
          deprecated: false
          enum:
          - draft
          - active
          - signed
          - expired
          - cancelled
          - declined
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        document_name:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        customer_acceptance_method:
          type: string
          default: esign_and_pay
          deprecated: false
          enum:
          - esign_and_pay
          - esign
          - pay
          example: null
        quote_type:
          type: string
          default: consolidated
          deprecated: false
          enum:
          - consolidated
          - detailed
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        timezone:
          type: string
          default: UTC
          deprecated: false
          maxLength: 100
          example: null
        provider_request_id:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        provider_document_id:
          type: string
          deprecated: false
          maxLength: 255
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - customer_acceptance_method
      - id
      - modified_at
      - quote_type
      - status
      example: null
    CreditNote:
      type: object
      additionalProperties: true
      description: |-
        <div class="api-description"><p class="mb-2">A <a href="https://www.chargebee.com/docs/1.0/credit-notes.html" target="_blank">Credit Note</a> is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other &#x27;due&#x27; invoices.</p><h3>Credit Note Types</h3><p class="mb-2">Credit notes in Chargebee are categorized into three types:
        1. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">adjustment</code>: Adjustment credit notes are used to adjust the amount of an existing invoice in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code> <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">status</a>. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer.
        Adjustment credit notes are automatically created in the following cases:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">When an invoice is written off.</li>
        <li class="text-base leading-relaxed">When a subscription is modified with proration enabled, and the invoice for the current term is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code> <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">status</a>.
        2. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refundable</code>: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:</li>
        <li class="text-base leading-relaxed">Retained for automatic application on future invoices.</li>
        <li class="text-base leading-relaxed">Applied to existing unpaid invoices.</li>
        <li class="text-base leading-relaxed">Refunded to the customer.
        Refundable credit notes are automatically created in the following cases:</li>
        <li class="text-base leading-relaxed">When an invoice is refunded.</li>
        <li class="text-base leading-relaxed">When a subscription is changed or canceled with proration enabled, the invoice for the current term is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paid</code> <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">status</a>. Refundable credits are applied to future invoices or can be refunded to the original payment method.
        3. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">store</code>: Store credit notes are created for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paid</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">partially_paid</code> invoice <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">status</a> during subscription changes, such as upgrades, downgrades, or cancellations.
        Key characteristics of store credits:</li>
        <li class="text-base leading-relaxed">No tax component is included at the time of creation.</li>
        <li class="text-base leading-relaxed">A credit note document is generated, similar to refundable credits.</li>
        <li class="text-base leading-relaxed">Store credits are applied before tax calculations on future invoices.</li>
        </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        If you have enabled <em class="italic">consolidated invoicing</em>
        , to know the subscriptions attached with a credit note you have to refer <a href="/docs/api/v2/pcv-1/credit_notes/credit_note-object#line_items">line_item&#x27;s</a>
        <em class="italic">subscription_id</em>
        . The credit note&#x27;s <em class="italic">subscription_id</em>
        should <strong class="font-semibold">not</strong>
        be used (which will be <em class="italic">null</em>
        if the credit note has lines from multiple subscriptions).</p></div></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Credit-note id.
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The identifier of the customer this credit note belongs to.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The identifier of the subscription this credit note belongs to.
            **Note:**
            If *consolidated invoicing*
            is enabled, to know the subscriptions attached with this credit note you have to refer [line_item's](/docs/api/credit_notes/credit_note-object#line_items)
            *subscription_id* .
            This attribute should **not**
            be used (which will be *null*
            if this credit note has lines from multiple subscriptions).
          maxLength: 50
          example: null
        reference_invoice_id:
          type: string
          deprecated: false
          description: |
            The identifier of the invoice against which this Credit Note is issued
          maxLength: 50
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)
            about credit note types.
            \* store -

            Store Credit Note
            \* refundable -

            Refundable Credit Note
            \* adjustment -

            Adjustment Credit Note
          enum:
          - adjustment
          - refundable
          - store
          example: null
        reason_code:
          type: string
          deprecated: false
          description: |
            The reason for issuing this credit note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)
            parameter instead\]
            \* subscription_change -

            This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
            is enabled
            \* order_change -

            Order Change
            \* other -

            Can be set when none of the above reason codes are applicable
            \* fraudulent -

            FRAUDULENT
            \* chargeback -

            Can be set when you are recording your customer Chargebacks
            \* subscription_pause -

            This reason will be automatically set to credit notes created during pause/resume subscription operation.
            \* waiver -

            Waiver
            \* subscription_cancellation -

            This reason will be set automatically for Credit Notes created during cancel subscription operation
            \* product_unsatisfactory -

            Product Unsatisfactory
            \* order_cancellation -

            Order Cancellation
            \* write_off -

            This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
            operation.
            \* service_unsatisfactory -

            Service Unsatisfactory
          enum:
          - write_off
          - subscription_change
          - subscription_cancellation
          - subscription_pause
          - chargeback
          - product_unsatisfactory
          - service_unsatisfactory
          - order_change
          - order_cancellation
          - waiver
          - other
          - fraudulent
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The credit note status.
            \* voided -

            When the Credit Note has been cancelled.
            \* refund_due -

            When the credits are yet to be used, or have been partially used.
            \* refunded -

            When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
            \* adjusted -

            When the credit note has been adjusted against an invoice.
          enum:
          - adjusted
          - refunded
          - refund_due
          - voided
          example: null
        vat_number:
          type: string
          deprecated: false
          description: |
            VAT number of the customer for whom this credit note is raised.
          maxLength: 20
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date the credit note is issued.
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          description: |
            The price type of the credit note.
            \* tax_inclusive -

            All amounts in the document are inclusive of tax.
            \* tax_exclusive -

            All amounts in the document are exclusive of tax.
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the credit note
          maxLength: 3
          example: null
        total:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Credit note amount in cents.
          minimum: 0
          example: null
        amount_allocated:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            The amount allocated to invoices from the credit note.
          minimum: 0
          example: null
        amount_refunded:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            The refunds issued from this credit note.
          minimum: 0
          example: null
        amount_available:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            The yet to be used credits of this credit note.
          minimum: 0
          example: null
        refunded_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time this Credit Note gets fully used. Please note that this field is not present when partial refunds are issued.
          example: null
        voided_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating the date and time this credit note gets voided.
          example: null
        generated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date/time when the credit note was raised. This date/time can be backdated, which means that the date/time can be earlier than the date/time the credit note was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this credit note was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\\* play_store -\n\nThe object data is synchronized\
            \ with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Google Play Store. Direct manipulation of this object via UI\
            \ or API is disallowed.  \nIn-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\nfor more\
            \ information.\n\\* web -\n\nThe object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n\\* app_store\
            \ -\n\nThe object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Apple App Store. Direct manipulation of this object via UI\
            \ or API is disallowed.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        line_items_next_offset:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This attribute is returned only if additional resources are available. Use this value as the input parameter for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items_offset</code> to retrieve the next set of resources.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li>
            <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this feature.</li>
            </ul></div>
          maxLength: 1000
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          description: |
            The credit note sub-total
          minimum: 0
          example: null
        sub_total_in_local_currency:
          type: integer
          format: int64
          deprecated: false
          description: |
            Credit note subtotal in the currency of the place of supply.
          minimum: 0
          example: null
        total_in_local_currency:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total credit note amount in the currency of the place of supply.
          minimum: 0
          example: null
        local_currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.
          maxLength: 3
          example: null
        round_off_amount:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
            If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
            , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
            .</p>
          maximum: 99
          minimum: -99
          example: null
        fractional_correction:
          type: integer
          format: int64
          deprecated: false
          description: |
            Indicates the fractional correction amount.
          maximum: 50000
          minimum: -50000
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        tax_category:
          type: string
          deprecated: false
          description: |
            Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.
          example: null
        local_currency_exchange_rate:
          type: number
          format: decimal
          deprecated: false
          description: |
            This parameter represents the exchange rate as a relative price of the base currency that appears as local currency in invoices and credit notes. The local currency exchange rate specifically refers to the exchange rate of a country's currency when converting it to another currency.

            For example, if you want to convert US dollars to euros, the local currency exchange rate would be the rate at which you can convert US dollars to euros.
          maximum: 1000000000
          minimum: 0.0000000010
          example: null
        create_reason_code:
          type: string
          deprecated: false
          description: |
            Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note**.
            Must be passed if set as mandatory in the app. The codes are case-sensitive
          maxLength: 100
          example: null
        vat_number_prefix:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
            Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
            ).</p>
            <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
            in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
            the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
            That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
            The first two characters of the VAT number in such a case is
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
            Set
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
            to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
            for such cases.</p>
          maxLength: 10
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            The line items of this credit note
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the subscription this line item belongs to.
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of this line item.
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of this line item.
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Unit amount of the line item.
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |
                  [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item.
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of this line item. Typically equals to unit amount x quantity
                example: null
              pricing_model:
                type: string
                deprecated: false
                description: |
                  The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                  for this item.
                  \* stairstep -

                  A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  \* flat_fee -

                  A fixed price that is not quantity-based.
                  \* tiered -

                  There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                  \* per_unit -

                  A fixed price per unit quantity.
                  \* volume -

                  The per unit price is based on the tier that the total quantity falls in.
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Specifies whether this line item is taxed or not
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The tax amount charged for this item
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                description: |
                  Rate of tax used to calculate tax for this lineitem
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                  x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                  Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total discounts for this line
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Line Item-level discounts for this line.
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                description: |
                  Invoice Reference Line Item ID
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this line item.
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this item.
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this line item is based on.
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                  * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                  * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                  * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                  * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                  * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                  * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                  * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                  * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                  * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                  * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                  and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                  have not been provided for the customer and subscription respectively</p>
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this line item belongs to
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_tiers:
          type: array
          deprecated: false
          description: |
            The list of tiers applicable for this line item
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of units purchased in a range.
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                  pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  pricing.</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          description: |
            The list of discount(s) applied for each line item of this invoice.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique id of the line item that this deduction is for.
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case.</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a coupon, then this is the id of the coupon.
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied on line items
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the tax is applicable
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The rate of tax used to calculate tax amount
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period end of the tax rate for the line item.
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period start of the tax rate for the line item.
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Indicates the prorated line item amount in cents.
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                description: |
                  Indicates if tax is applied only on a portion of the line item amount.
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                description: |
                  Indicates the non-compliance tax that should not be reported to the jurisdiction.
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Indicates the actual portion of the line item amount that is taxable.
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                description: |
                  The type of tax jurisdiction
                  \* federal -

                  The tax jurisdiction is a federal
                  \* state -

                  The tax jurisdiction is a state
                  \* county -

                  The tax jurisdiction is a county
                  \* country -

                  The tax jurisdiction is a country
                  \* city -

                  The tax jurisdiction is a city
                  \* special -

                  Special tax jurisdiction.
                  \* unincorporated -

                  Combined tax of state and county.
                  \* other -

                  Jurisdictions other than the ones listed above.
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax jurisdiction
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                description: |
                  The tax jurisdiction code
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        line_item_addresses:
          type: array
          deprecated: false
          description: |
            The list of addresses used for tax calculation on line items.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  Line item reference
                maxLength: 40
                example: null
              first_name:
                type: string
                deprecated: false
                description: |
                  First name of the customer
                maxLength: 150
                example: null
              last_name:
                type: string
                deprecated: false
                description: |
                  Last name of the customer
                maxLength: 150
                example: null
              email:
                type: string
                format: email
                deprecated: false
                description: |
                  Email address of the customer
                maxLength: 70
                example: null
              company:
                type: string
                deprecated: false
                description: |
                  Name of the company
                maxLength: 250
                example: null
              phone:
                type: string
                deprecated: false
                description: |
                  Phone number of the customer
                maxLength: 50
                example: null
              line1:
                type: string
                deprecated: false
                description: |
                  Address line 1
                maxLength: 150
                example: null
              line2:
                type: string
                deprecated: false
                description: |
                  Address line 2
                maxLength: 150
                example: null
              line3:
                type: string
                deprecated: false
                description: |
                  Address line 3
                maxLength: 150
                example: null
              city:
                type: string
                deprecated: false
                description: |
                  Name of the city
                maxLength: 50
                example: null
              state_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                  without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                  as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                  ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                  ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                  ).</p>
                maxLength: 50
                example: null
              state:
                type: string
                deprecated: false
                description: |
                  State or Province
                maxLength: 50
                example: null
              country:
                type: string
                deprecated: false
                description: "The billing address of the customer, specified as an\
                  \ [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                  Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                  \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                  \ is enabled, 'United Kingdom-Northern Ireland' is a valid option.\n"
                maxLength: 50
                example: null
              zip:
                type: string
                deprecated: false
                description: |
                  Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                  .
                maxLength: 20
                example: null
              validation_status:
                type: string
                default: not_validated
                deprecated: false
                description: |
                  The address verification status.
                  \* invalid -

                  Address is invalid.
                  \* not_validated -

                  Address is not yet validated.
                  \* partially_valid -

                  The address is valid for taxability but has not been validated for shipping.
                  \* valid -

                  Address was validated successfully.
                enum:
                - not_validated
                - valid
                - partially_valid
                - invalid
                example: null
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            The list of discounts applied to this credit note
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description for this deduction.
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                  .</p>
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice.</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                  , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  of the coupon.</p>
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                  , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                  is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          description: |
            The tax-lines of this credit note
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied. E.g. GST.
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description of the tax item.
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
        tax_origin:
          type: object
          deprecated: false
          description: |
            contains information about the tax details which is applied on the invoice.
          properties:
            country:
              type: string
              deprecated: false
              description: |
                The country code in ([ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)
                ) where the tax originated from.
              maxLength: 50
              example: null
            registration_number:
              type: string
              deprecated: false
              description: |
                It represents the tax registration number for the entity used to collect tax.
              maxLength: 100
              example: null
          example: null
        linked_refunds:
          type: array
          deprecated: false
          description: |
            Payment Refunds issued from this credit note
          items:
            type: object
            deprecated: false
            properties:
              txn_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the transaction.
                maxLength: 40
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The transaction amount applied to this invoice
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Time when the transaction amount applied to this invoice
                example: null
              txn_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of this transaction.</p>
                  * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                  for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                  transaction to be reconciled at par with the gateway.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transaction status</p></div>
                  * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                  * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                  * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                  * success - <p class="mb-2">The transaction is successful.</p>
                  * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                  * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              txn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates when this transaction occurred.
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of the transaction
                minimum: 0
                example: null
              refund_reason_code:
                type: string
                deprecated: false
                description: |
                  Reason code for the refund. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Refund Credit Note**.
                  Must be passed if set as mandatory in the app. The codes are case-sensitive
                maxLength: 100
                example: null
            required:
            - applied_amount
            - applied_at
            - txn_id
            example: null
          example: null
        linked_tax_withheld_refunds:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">The details of refunds recorded against the <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">invoice.linked_taxes_withheld</a></code>
            component of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code>
            <a href="/docs/api/credit_notes/credit_note-object#reference_invoice_id">associated</a>
            with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>.</p>
            <span featureId="cb-tax-withheld" isMicro="true"></span>
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_</code>.
                  For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_16BdDXSlbu4uV1Ee6</code>
                  .</p>
                maxLength: 40
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 1
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  The description for this tax withheld.
                maxLength: 65000
                example: null
              date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Date or time associated with the tax withheld.
                example: null
              reference_number:
                type: string
                deprecated: false
                description: |
                  A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
                maxLength: 100
                example: null
            required:
            - id
            example: null
          example: null
        allocations:
          type: array
          deprecated: false
          description: |
            Invoice allocations made from this credit note.
          items:
            type: object
            deprecated: false
            properties:
              invoice_id:
                type: string
                deprecated: false
                description: |
                  Unique identifier of the invoice.
                maxLength: 50
                example: null
              allocated_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Amount of this refund transaction.
                minimum: 0
                example: null
              allocated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates when this refund occured.
                example: null
              invoice_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Closing date of the invoice. Typically this is the date on which invoice is generated
                example: null
              invoice_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Current status of the invoice.</p>
                  * not_paid - <p class="mb-2">Indicates the payment is not made and all attempts to collect is failed.</p>
                  * paid - <p class="mb-2">Indicates a paid invoice.</p>
                  * voided - <p class="mb-2">Indicates a voided invoice.</p>
                  * posted - <p class="mb-2">Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period</p>
                  * pending - <p class="mb-2">The <a href="/docs/api/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when it has line items that belong to items that are <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> or when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.create_pending_invoices</code>attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                  The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site.</p>
                  * payment_due - <p class="mb-2">Indicates the payment is not yet collected and is being retried as per retry settings.</p>
                enum:
                - paid
                - posted
                - payment_due
                - not_paid
                - voided
                - pending
                example: null
              tax_application:
                type: string
                deprecated: false
                description: |
                  Specifies how tax is handled for invoice allocations made from this credit note.
                  \* pre_tax -

                  Allocations are applied before tax calculation.
                  \* post_tax -

                  Allocations are applied after tax calculation.
                enum:
                - pre_tax
                - post_tax
                example: null
            required:
            - allocated_amount
            - allocated_at
            - invoice_id
            - invoice_status
            example: null
          example: null
        shipping_address:
          type: object
          deprecated: false
          description: |
            Shipping address for the credit note.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* not_validated -

                Address is not yet validated.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for the credit note.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
                \* not_validated -

                Address is not yet validated.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        einvoice:
          type: object
          deprecated: false
          description: |
            An e-invoice or electronic invoice is a structured representation of an invoice that is interoperable between computerized invoicing systems. Depending on the country, e-invoicing can be necessary to meet financial/taxation authority regulations.
          properties:
            id:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                for the e-invoice. This is auto-generated by Chargebee.</p>
              maxLength: 50
              example: null
            reference_id:
              type: string
              deprecated: false
              description: |
                Identifier returned by the connected e-invoicing provider for this submission (for example, a document submission id). Chargebee uses this value when communicating with the provider to retrieve submission status and related artifacts.
              maxLength: 50
              example: null
            reference_number:
              type: string
              deprecated: false
              description: |
                This attribute is used to populate the unique reference number assigned to an invoice on the Invoice Registration Portal (IRP) network. It is essential for identifying and tracking invoices that are processed through the IRP network.

                In the future, this field may be used to store similar reference numbers for other networks.
              maxLength: 100
              example: null
            status:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                , see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code>
                .</p>
                * message_acknowledgement - <p class="mb-2">An acknowledgment confirming that the application response was successfully received by the receiving entity.</p>
                * under_query - <p class="mb-2">The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.</p>
                * rejected - <p class="mb-2">The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.</p>
                * scheduled - <p class="mb-2">Sending the e-invoice to the customer has been scheduled.</p>
                * paid - <p class="mb-2">The receiving entity has confirmed that the e-invoice has been paid.</p>
                * conditionally_accepted - <p class="mb-2">The e-invoice has been accepted with conditions.</p>
                * accepted - <p class="mb-2">The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.</p>
                * skipped - <p class="mb-2">The e-invoice was not sent. This could be due to missing information or because the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                is not registered on the e-invoicing network.</p>
                * success - <p class="mb-2">The e-invoice has been successfully delivered to the customer.</p>
                * failed - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered.</p>
                * in_progress - <p class="mb-2">The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.</p>
                * in_process - <p class="mb-2">The e-invoice is currently being processed by the receiving entity.</p>
                * registered - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.</p>
              enum:
              - scheduled
              - skipped
              - in_progress
              - success
              - failed
              - registered
              - accepted
              - rejected
              - message_acknowledgement
              - in_process
              - under_query
              - conditionally_accepted
              - paid
              example: null
            message:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">Detailed information about the status of the e-invoice. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skipped</code>
                or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code>
                , this contains the reason or error details. The following are some valid examples:</p>
                <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">Invoice successfully sent to customer via the e-invoicing network 9090:123456</li>
                <li class="text-base leading-relaxed">Invoice successfully sent to customer via email id abc@acme.com</li>
                </ul>
              maxLength: 3000
              example: null
            provider_references:
              type: array
              deprecated: false
              items:
                example: null
              example: null
          required:
          - id
          - status
          example: null
        site_details_at_creation:
          type: object
          deprecated: false
          description: |
            It contains site-specific information, including timezone and organisational address.
          properties:
            timezone:
              type: string
              deprecated: false
              description: |
                It represents the timezone of the site at the time of entity creation.
              maxLength: 50
              example: null
            organization_address:
              type: object
              additionalProperties: true
              deprecated: false
              description: |
                It represents the address configured for the site during entity creation.
              example: null
          example: null
      required:
      - currency_code
      - customer_id
      - deleted
      - id
      - price_type
      - status
      - sub_total
      - type
      example: null
    CreditNoteCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CreditNoteCreatedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CreditNoteDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CreditNoteEstimate:
      type: object
      properties:
        reference_invoice_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - adjustment
          - refundable
          - store
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        amount_allocated:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        amount_available:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        round_off_amount:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        line_items:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                example: null
              pricing_model:
                type: string
                deprecated: false
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_tiers:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
      required:
      - amount_allocated
      - amount_available
      - currency_code
      - price_type
      - reference_invoice_id
      - sub_total
      - total
      - type
      example: null
    CreditNoteUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CreditOptionForCurrentTermCharges:
      type: string
      deprecated: false
      enum:
      - none
      - prorate
      - full
      example: null
    CreditType:
      type: string
      default: general
      deprecated: false
      enum:
      - loyalty_credits
      - referral_rewards
      - general
      example: null
    CsvTaxRule:
      type: object
      properties:
        tax_profile_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        country:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        state:
          type: string
          default: '*'
          deprecated: false
          maxLength: 50
          example: null
        zip_code:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        zip_code_start:
          type: integer
          format: int32
          deprecated: false
          example: null
        zip_code_end:
          type: integer
          format: int32
          deprecated: false
          example: null
        tax1_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        tax1_rate:
          type: number
          format: double
          deprecated: false
          maximum: 100
          minimum: 0
          example: null
        tax1_juris_type:
          type: string
          deprecated: false
          enum:
          - country
          - federal
          - state
          - county
          - city
          - special
          - unincorporated
          - other
          example: null
        tax1_juris_name:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax1_juris_code:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax2_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        tax2_rate:
          type: number
          format: double
          deprecated: false
          maximum: 100
          minimum: 0
          example: null
        tax2_juris_type:
          type: string
          deprecated: false
          enum:
          - country
          - federal
          - state
          - county
          - city
          - special
          - unincorporated
          - other
          example: null
        tax2_juris_name:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax2_juris_code:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax3_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        tax3_rate:
          type: number
          format: double
          deprecated: false
          maximum: 100
          minimum: 0
          example: null
        tax3_juris_type:
          type: string
          deprecated: false
          enum:
          - country
          - federal
          - state
          - county
          - city
          - special
          - unincorporated
          - other
          example: null
        tax3_juris_name:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax3_juris_code:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax4_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        tax4_rate:
          type: number
          format: double
          deprecated: false
          maximum: 100
          minimum: 0
          example: null
        tax4_juris_type:
          type: string
          deprecated: false
          enum:
          - country
          - federal
          - state
          - county
          - city
          - special
          - unincorporated
          - other
          example: null
        tax4_juris_name:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        tax4_juris_code:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - active
          - expired
          - scheduled
          example: null
        time_zone:
          type: string
          deprecated: false
          maxLength: 4
          example: null
        valid_from:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        valid_till:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        service_type:
          type: string
          deprecated: false
          enum:
          - digital
          - other
          - not_applicable
          example: null
        rule_weight:
          type: integer
          format: int32
          deprecated: false
          example: null
        overwrite:
          type: boolean
          default: false
          deprecated: false
          example: null
      required:
      - overwrite
      - tax1_name
      - tax1_rate
      example: null
    Currency:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">Chargebee&#x27;s Multi-currency feature allows you to create Plans in multiple currencies, enabling your customers to conveniently pay in their preferred local currency. Please review this <a href="https://www.chargebee.com/docs/1.0/multi-currency-pricing.html">documentation</a> to understand the multi-currency feature in Chargebee.</p><p class="mb-2">This currency resource contains exchange rate configurations associated with a specific currency. The multi-currency feature must be <a href="https://www.chargebee.com/docs/1.0/multi-currency-pricing.html#1-adding-and-managing-currencies">enabled</a>, and all prerequisites must be addressed to successfully add a new currency via the API.
        To invoke a single currency-specific API like update, retrieve, and more, the currency ID has to be passed as a path parameter. You can use list API to fetch the IDs of each currency configured in your site to use with the currency-specific APIs below. Chargebee supports billing in over <a href="https://www.chargebee.com/docs/1.0/supported-currencies.html" target="_blank">100 currencies</a>.
        On this page, you can find information about how currency units are expressed in the API, as well as some pointers to keep in mind when using multiple currencies.</p><h2>Currency values</h2><p class="mb-2">By default, the Chargebee API supports only whole numbers for currency values. To allow for fractional (decimal) values, you must enable the <a href="https://www.chargebee.com/docs/1.0/multi-decimal-support.html" target="_blank">multi-decimal pricing</a> feature. Additionally, the units in which currencies are expressed in the API depend on whether the currency is zero-decimal and whether multi-decimal pricing is enabled.</p><h3>Whole number currency values</h3><p class="mb-2">By default, Chargebee supports currency values in whole numbers; fractions are not supported. In the API, currency values can be identified by checking their data types. For all whole number currency values in this API, the data type is indicated as &quot;in cents&quot; in this documentation.</p><p class="mb-2">The specific unit used for the currency in the API depends on whether it is a zero-decimal currency:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">Zero-decimal currencies</strong>: For currencies that do not have decimal subunits, such as the Japanese Yen (JPY), the amount must be provided in the major unit of the currency. The major unit of a currency is the unit represented by its <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217 code</a>. For example, to specify an amount of JPY 15, set the amount as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">15</code>.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">Other currencies</strong>: For currencies that are not zero-decimal, Chargebee supports values up to two decimal places in the major unit of the currency. This value with two decimal places must be converted to an integer by multiplying it by 100. For example, $1.53 should be provided as 1.53 x 100, which is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">153</code>.</li>
        </ul><h3>Fractional currency values</h3><p class="mb-2">When <a href="https://www.chargebee.com/docs/1.0/multi-decimal-support.html#configuring-multi-decimal-support" target="_blank">multi-decimal pricing</a> is enabled in Chargebee, you can work with fractional currency values using dedicated API parameters and attributes of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">String</code> type. Usually, these attributes and parameters have the suffix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">_in_decimal</code> in their names. The value is expressed in the major unit of the currency, which is the unit represented by its <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217 code</a>. For example, $1.6782 should be provided as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">1.6782</code>. The maximum number of decimal places supported by the API can be <a href="https://www.chargebee.com/docs/1.0/multi-decimal-support.html#configuring-multi-decimal-support" target="_blank">configured</a> in the admin console.</p><p class="mb-2"><strong class="font-semibold">Note:</strong> For <strong class="font-semibold">zero-decimal currencies</strong>, such as the Japanese Yen (JPY), decimal places are not allowed.</p><h4>Rounding of invoice line item amounts</h4><p class="mb-2">While Chargebee supports multiple decimal places for currency values, at the <a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_amount">invoice line item</a>
        -level, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount</code>
        attribute is always rounded off to two decimal places in the major unit of the currency. The major unit of a currency is the unit represented by its
        <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217 code</a>
        .</p><p class="mb-2">The rounding logic used is <code><a href="https://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html#ROUND_HALF_EVEN" target="_blank">ROUND_HALF_EVEN</a></code>
        . For example, if the <code><a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity">quantity</a></code>
        is 0.0765 and <code><a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_unit_amount">unit_amount</a></code>
        is $10.674, the line item <code><a href="/docs/api/v2/pcv-1/invoices/invoice-object#line_items_amount">amount</a></code>
        is (0.0765 x $10.674) = $0.816561 and is rounded off to $0.82.</p><h2>Multi-currency support</h2><p class="mb-2">By default, Chargebee is able to process transactions in only one currency. However, you can enable the <a href="https://www.chargebee.com/docs/1.0/multi-currency-pricing.html" target="_blank">multi-currency</a> feature to support more currencies. The first currency enabled in Chargebee also becomes the &quot;base currency&quot; by default. If you have multiple currencies enabled and want to change the base currency for your site, reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Support</a> for assistance.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Warning</strong></p><p class="mb-2">For some API endpoints, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">currency_code</code> parameter becomes <em class="italic">required</em> when the multi-currency feature is enabled. Before enabling the feature for your site, ensure that you update your code to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">currency_code</code> parameter when calling the endpoints listed in the next section.</p></div><h3>List of affected endpoints</h3><p class="mb-2">The following endpoints require the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">currency_code</code>
        parameter to be passed when the multi-currency feature has been enabled.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <p class="mb-2">Customer-related endpoints</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/promotional_credits/add-promotional-credits">Add promotional credits for a customer</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/promotional_credits/deduct-promotional-credits">Deduct promotional credits from a customer</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/promotional_credits/set-promotional-credits">Set promotional credits for a customer</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/customers/record-an-excess-payment-for-a-customer">Record an excess payment for a customer</a>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Invoice-related endpoints</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/invoices/create-an-invoice">Create an invoice</a>
        </li>
        <li class="text-base leading-relaxed">
        <p class="mb-2">Product catalog-related endpoints</p>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/plans/create-a-plan">Create a plan</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/addons/create-an-addon">Create an addon</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/coupons/create-a-coupon">Create a coupon</a>
        </li>
        </ul></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of a currency.
          maxLength: 40
          example: null
        enabled:
          type: boolean
          default: true
          deprecated: false
          description: |-
            <p class="mb-2">This field mentions whether the foreign currency is active or archived. If the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            the foreign currency is archived else it is active</p>
          example: null
        forex_type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This represents the exchange rate type set for the currency.</p>
            * auto - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto</code>
            , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)</p>
            * manual - <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
            , you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it</p>
          enum:
          - manual
          - auto
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            A three letter currency code. For example, GBR, INR, and more.
          maxLength: 3
          example: null
        is_base_currency:
          type: boolean
          default: false
          deprecated: false
          description: |-
            <p class="mb-2">Check whether this is a base currency or not. The value of the attribute is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            when the currency matches the site&#x27;s base currency.</p>
          example: null
        manual_exchange_rate:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This attribute shows the exchange rate in decimal. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">forex_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual</code>
            you have to set the exchange rate for additional currencies in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manual_exchange_rate</code>
            field.</p>
          maxLength: 20
          example: null
      required:
      - currency_code
      - enabled
      - id
      - is_base_currency
      example: null
    CustomFieldConfig:
      type: object
      description: |
        This resource represents the configuration for a specific [custom field](/docs/api/advanced-features#custom-fields).
      properties:
        entity_type:
          type: string
          deprecated: false
          description: |
            Entity type that this configuration applies to.
            \* item -

            Item entity.
            \* invoice -

            Invoice entity.
            \* subscription_entitlement -

            Subscription entitlement entity.
            \* plan -

            Plan entity.
            \* transaction -

            Transaction entity.
            \* quote -

            Quote entity.
            \* plan_price -

            Plan price entity.
            \* customer -

            Customer entity.
            \* differential_price -

            Differential price entity.
            \* attached_item -

            Attached item entity.
            \* coupon -

            Coupon entity.
            \* subscription -

            Subscription entity.
            \* addon -

            Addon entity.
            \* addon_price -

            Addon price entity.
            \* charge_item -

            Charge item entity.
            \* feature -

            Feature entity.
            \* item_entitlement -

            Item entitlement entity.
            \* addon_item -

            Addon item entity.
            \* charge_price -

            Charge price entity.
            \* item_family -

            Item family entity.
            \* plan_item -

            Plan item entity.
            \* order -

            Order entity.
            \* item_price -

            Item price entity.
            \* business_entity -

            Business entity.
            \* credit_note -

            Credit note entity.
          enum:
          - customer
          - subscription
          - invoice
          - quote
          - credit_note
          - transaction
          - plan
          - addon
          - coupon
          - order
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - differential_price
          - attached_item
          - feature
          - subscription_entitlement
          - item_entitlement
          - business_entity
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          - recorded_purchase
          - omnichannel_subscription_item_scheduled_change
          - sales_order
          - omnichannel_one_time_order
          - omnichannel_one_time_order_item
          - usage_file
          - business_rule
          - ruleset
          - alert_status
          example: null
        api_name:
          type: string
          deprecated: false
          description: |
            Unique identifier for the custom field, used in API requests and responses.
          maxLength: 50
          example: null
        display_name:
          type: string
          deprecated: false
          description: |
            Name of the field as it appears in the user interface.
          maxLength: 50
          example: null
        field_datatype:
          type: string
          deprecated: false
          description: |
            Data type of the custom field value.
            \* double -

            Double-precision number.
            \* long -

            Integer (long).
            \* timestamp -

            Timestamp value.
            \* date -

            Date value.
            \* email -

            Email address.
            \* url -

            URL value.
            \* string -

            String value.
          enum:
          - string
          - long
          - double
          - timestamp
          - email
          - url
          - date
          example: null
        edit_ui:
          type: string
          deprecated: false
          description: |
            UI component type used to input or edit the field value.
            \* radio_button_horizontal -

            Horizontal radio button group.
            \* radio_button_vertical -

            Vertical radio button group.
            \* text_area -

            Multi-line text input.
            \* text -

            Single-line text input.
            \* date_field -

            Date picker input.
            \* date_time_field -

            Date and time picker input.
            \* password -

            Password input (masked).
            \* drop_down -

            Dropdown select input.
            \* check_box -

            Check box input.
            \* file -

            File upload input.
          enum:
          - text
          - text_area
          - date_time_field
          - drop_down
          - radio_button_horizontal
          - radio_button_vertical
          - date_field
          - check_box
          - file
          - password
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the custom field.
          maxLength: 250
          example: null
        required:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether the custom field is mandatory or optional.
          example: null
        props:
          type: string
          deprecated: false
          description: |
            JSON object containing additional properties for the field (for example, options for a dropdown).
          maxLength: 5000
          example: null
        field_order:
          type: integer
          format: int32
          deprecated: false
          description: |
            Display order of the field in the user interface.
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |
            Whether the custom field configuration is active or archived.
            \* archived -

            Only available in the index list page; soft deleted.
            \* active -

            Visible and ready to use.
          enum:
          - active
          - archived
          example: null
        published_status:
          type: string
          default: new
          deprecated: false
          description: |
            Publishing status of the custom field configuration.
            \* new -

            New configuration not yet published.
            \* draft -

            Configuration is in draft and not yet published.
            \* published -

            Configuration is published and in use.
          enum:
          - new
          - published
          - draft
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the custom field configuration was created.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the custom field configuration was last updated.
          example: null
      required:
      - api_name
      - created_at
      - display_name
      - entity_type
      - field_datatype
      - modified_at
      - props
      - published_status
      - required
      - status
      example: null
    Customer:
      type: object
      additionalProperties: true
      description: |-
        <div class="api-description"><p class="mb-2">Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with <a href="/docs/api/v2/pcv-1/subscriptions/subscription-object">subscriptions</a>, <a href="/docs/api/v2/pcv-1/cards/card-object">card information</a>, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you&#x27;d like to associate with them.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Breaking Change</strong>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/sites-intro.html" target="_blank"><strong class="font-semibold">Sites</strong></a>** created before March 1, 2014**: <a href="/docs/api/v2/pcv-1/cards/update-card-for-a-customer">updating the card</a> deletes the customer&#x27;s <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> and replaces them with values from the request.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">Sites created on or after March 1, 2014</strong>: updating the card doesn&#x27;t change the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>.</li>
        </ul></div></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        first_name:
          type: string
          deprecated: false
          description: |
            First name of the customer
          maxLength: 150
          example: null
        last_name:
          type: string
          deprecated: false
          description: |
            Last name of the customer
          maxLength: 150
          example: null
        email:
          type: string
          format: email
          deprecated: false
          description: |
            Email of the customer. Configured email notifications will be sent to this email.
          maxLength: 70
          example: null
        phone:
          type: string
          deprecated: false
          description: |
            Phone number of the customer
          maxLength: 50
          example: null
        company:
          type: string
          deprecated: false
          description: |
            Company name of the customer.
          maxLength: 250
          example: null
        vat_number:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
            ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>
            can be overridden by setting
            <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code>
            .</p>
          maxLength: 20
          example: null
        auto_collection:
          type: string
          default: "on"
          deprecated: false
          description: |
            Whether payments needs to be collected automatically for this customer
            \* on -

            Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
            \* off -

            Automatic collection of charges will not be made. All payments must be recorded offline.
          enum:
          - "on"
          - "off"
          example: null
        offline_payment_method:
          type: string
          deprecated: false
          description: |
            The preferred offline payment method for the customer.
            \* sepa_credit -

            SEPA Credit
            \* cash -

            Cash
            \* no_preference -

            No Preference
            \* bank_transfer -

            Bank Transfer
            \* check -

            Check
            \* eu_automated_bank_transfer -

            EU Automated Bank Transfer
            \* jp_automated_bank_transfer -

            JP Automated Bank Transfer
            \* uk_automated_bank_transfer -

            UK Automated Bank Transfer
            \* custom -

            Custom
            \* boleto -

            Boleto
            \* mx_automated_bank_transfer -

            MX Automated Bank Transfer
            \* us_automated_bank_transfer -

            US Automated Bank Transfer
            \* ach_credit -

            ACH Credit
          enum:
          - no_preference
          - cash
          - check
          - bank_transfer
          - ach_credit
          - sepa_credit
          - boleto
          - us_automated_bank_transfer
          - eu_automated_bank_transfer
          - uk_automated_bank_transfer
          - jp_automated_bank_transfer
          - mx_automated_bank_transfer
          - custom
          example: null
        net_term_days:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: |
            The number of days within which the customer has to make payment for the invoice.
          example: null
        vat_number_validated_time:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Returns the recent VAT number validation time.
          example: null
        vat_number_status:
          type: string
          deprecated: false
          description: |
            Represents the VAT validation status. This is applicable if you have configured EU, UK or Australian taxes and the [VAT number validation](https://www.chargebee.com/docs/2.0/uk-vat.html#uk-vat-validation)
            is enabled.
            \* not_validated -

            This status is only applicable for countries in European Zone. This is applicable when both the customer's billing address and the organization's address should be of the same European Zone and EU tax should be configured with the "Also validate VAT Number for Country of Business" option in the disabled status.
            \* undetermined -

            When Chargebee is not able to validate the VAT number it is stored as 'undetermined'. This can occur due to reasons like service outage etc. VAT numbers with 'undetermined' status will be in queue for validation on daily basis.
            \* valid -

            If the given VAT number is valid.
            \* invalid -

            If the given VAT number is invalid.
          enum:
          - valid
          - invalid
          - not_validated
          - undetermined
          example: null
        allow_direct_debit:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether the customer can pay via Direct Debit
          example: null
        is_location_valid:
          type: boolean
          deprecated: false
          description: |
            Customer location is validated based on IP address and Card issuing country. If the location is valid, it returns True. If not, it returns False. Applicable only for EU, New Zealand and Australia.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this customer resource is created.
          example: null
        created_from_ip:
          type: string
          deprecated: false
          description: |
            The IP address of the customer. Used primarily for [referral integrations](https://www.chargebee.com/docs/marketing-integration-index.html)
            and EU/UK VAT validation.
          maxLength: 50
          example: null
        exemption_details:
          type: array
          deprecated: false
          description: |
            Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
            To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)
            .
          items:
            example: null
          example: null
        taxability:
          type: string
          default: taxable
          deprecated: false
          description: |-
            <p class="mb-2">Specifies if the customer is liable for tax</p>
            * taxable - <p class="mb-2">Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>.
            In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that&#x27;s not available either, the tax is taken as zero.</p>
            * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee&#x27;s native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li>
            <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee&#x27;s <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee&#x27;s AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li>
            </ul>
          enum:
          - taxable
          - exempt
          example: null
        entity_code:
          type: string
          deprecated: false
          description: |
            The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
            .
            \* l -

            Other or custom
            \* m -

            Educational organization
            \* n -

            Local government
            \* h -

            Commercial agricultural production
            \* i -

            Industrial production/manufacturer
            \* j -

            Direct pay permit
            \* k -

            Direct mail
            \* p -

            Commercial aquaculture
            \* q -

            Commercial Fishery
            \* r -

            Non-resident
            \* d -

            Foreign diplomat
            \* e -

            Charitable or benevolent organization
            \* f -

            Religious organization
            \* g -

            Resale
            \* a -

            Federal government
            \* b -

            State government
            \* c -

            Tribe/Status Indian/Indian Band
            \* med2 -

            US Medical Device Excise Tax with taxable sales tax
            \* med1 -

            US Medical Device Excise Tax with exempt sales tax
          enum:
          - a
          - b
          - c
          - d
          - e
          - f
          - g
          - h
          - i
          - j
          - k
          - l
          - m
          - "n"
          - p
          - q
          - r
          - med1
          - med2
          example: null
        exempt_number:
          type: string
          deprecated: false
          description: |
            Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)
            .
          maxLength: 100
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this customer was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
          example: null
        locale:
          type: string
          deprecated: false
          description: |
            Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
          maxLength: 50
          example: null
        billing_date:
          type: integer
          format: int32
          deprecated: false
          description: |
            Applicable when *calendar billing*
            (with customer specific billing date support) is enabled. When set, renewals of all the monthly and yearly subscriptions of this customer will be aligned to this date.
          maximum: 31
          minimum: 1
          example: null
        billing_month:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_month</code>, together with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code>, specify, for this customer, the day of the year when the renewals of all the year-based subscriptions take place.</p>
            <p class="mb-2">For example, the renewals happen on 15th July when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_month</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">7</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">15</code>.</p>
            <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong>
            Applicable when <a href="https://www.chargebee.com/docs/calendar-billing.html" target="_blank">Calendar Billing</a> (with customer-specific billing date support) is enabled and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date_mode</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manually_set</code>.</p></div>
          maximum: 12
          minimum: 1
          example: null
        billing_date_mode:
          type: string
          deprecated: false
          description: |
            Indicates whether this customer's *billing_date*
            value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_date*
            will not be reset even when all of the monthly/yearly subscriptions are cancelled.
            \* manually_set -

            Billing date is specifically set (default configuration is overridden)
            \* using_defaults -

            Billing date is set based on defaults configured.
          enum:
          - using_defaults
          - manually_set
          example: null
        billing_day_of_week:
          type: string
          deprecated: false
          description: |
            Applicable when *calendar billing*
            (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day.
            \* saturday -

            Saturday
            \* monday -

            Monday
            \* friday -

            Friday
            \* sunday -

            Sunday
            \* wednesday -

            Wednesday
            \* thursday -

            Thursday
            \* tuesday -

            Tuesday
          enum:
          - sunday
          - monday
          - tuesday
          - wednesday
          - thursday
          - friday
          - saturday
          example: null
        billing_day_of_week_mode:
          type: string
          deprecated: false
          description: |
            Indicates whether this customer's *billing_day_of_week*
            value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week*
            will not be reset even when all of the weekly subscriptions are cancelled.
            \* using_defaults -

            Billing date is set based on defaults configured.
            \* manually_set -

            Billing date is specifically set (default configuration is overridden)
          enum:
          - using_defaults
          - manually_set
          example: null
        pii_cleared:
          type: string
          default: active
          deprecated: false
          description: |
            Indicates whether this customer's personal information has been cleared
            \* cleared -

            Cleared
            \* scheduled_for_clear -

            Scheduled For Clear
            \* active -

            Active
          enum:
          - active
          - scheduled_for_clear
          - cleared
          example: null
        auto_close_invoices:
          type: boolean
          deprecated: false
          description: |
            Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)
            for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)
            which takes precedence.
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\\* play_store -\n\nThe object data is synchronized\
            \ with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Google Play Store. Direct manipulation of this object via UI\
            \ or API is disallowed.  \nIn-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\nfor more\
            \ information.\n\\* web -\n\nThe object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n\\* app_store\
            \ -\n\nThe object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Apple App Store. Direct manipulation of this object via UI\
            \ or API is disallowed.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        active_id:
          type: string
          deprecated: false
          description: |
            This attribute is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)
            as the Multiple Business Entity features can only be enabled for product catalog 2.0.
          maxLength: 50
          example: null
        fraud_flag:
          type: string
          deprecated: false
          description: |
            Indicates whether or not the customer has been identified as fraudulent.
            \* suspicious -

            The customer has been identified as potentially fraudulent by the gateway
            \* safe -

            The customer has been marked as safe
            \* fraudulent -

            The customer has been marked as fraudulent
          enum:
          - safe
          - suspicious
          - fraudulent
          example: null
        primary_payment_source_id:
          type: string
          deprecated: false
          description: |
            Primary payment source for the customer.
          maxLength: 40
          example: null
        backup_payment_source_id:
          type: string
          deprecated: false
          description: |
            Backup payment source for the customer. Used to collect payment if primary payment source fails.
          maxLength: 40
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
            displayed on the invoice PDF.
          maxLength: 2000
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        preferred_currency_code:
          type: string
          deprecated: false
          description: |
            The currency code of the customer's preferred currency (ISO 4217 format). Applicable if the Multicurrency feature is enabled.
          maxLength: 3
          example: null
        promotional_credits:
          type: integer
          format: int64
          deprecated: false
          description: |
            Promotional credits balance of this customer
          minimum: 0
          example: null
        unbilled_charges:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total unbilled charges for this customer
          minimum: 0
          example: null
        refundable_credits:
          type: integer
          format: int64
          deprecated: false
          description: |
            Refundable credits balance of this customer
          minimum: 0
          example: null
        excess_payments:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total unused payments associated with the customer
          minimum: 0
          example: null
        is_einvoice_enabled:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>
            ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            , the customer is not e-invoiced even if e-invoicing is enabled for their country.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</p></div>
            <span featureId="cb-einvoicing" isMicro="true"></span>
          example: null
        einvoicing_method:
          type: string
          deprecated: false
          description: |
            Determines whether to send einvoice manually or automatic.
            \* automatic -

            Use this value to send e-invoice every time an invoice or credit note is created.
            \* manual -

            When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
            \* site_default -

            The default value of the site which can be overridden at the customer level.
          enum:
          - automatic
          - manual
          - site_default
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the customer. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Indicates that this resource has been deleted when the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            .</p>
          example: null
        registered_for_gst:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a>
            is applicable. This field is applicable only when Australian GST is configured for your site.</p>
          example: null
        consolidated_invoicing:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When present, this value overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This attribute is applicable only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</p></div>
          example: null
        customer_type:
          type: string
          deprecated: false
          description: |
            Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
            \* industrial -

            When the purchase is made by an industrial business
            \* residential -

            When the purchase is made by a customer for home use
            \* senior_citizen -

            When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks
            \* business -

            When the purchase is made at a place of business
          enum:
          - residential
          - business
          - senior_citizen
          - industrial
          example: null
        business_customer_without_vat_number:
          type: boolean
          deprecated: false
          description: |
            Confirms that a customer is a valid business without an EU/UK VAT number.
          example: null
        client_profile_id:
          type: string
          deprecated: false
          description: |
            Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
          maxLength: 50
          example: null
        use_default_hierarchy_settings:
          type: boolean
          default: true
          deprecated: false
          description: |
            Indicates whether the site-default settings are being used for controlling access to the customer's information.
            The level of access is for data falling into two categories: - **Self-Serve Portal data:** subscriptions and invoices of the customer.

            * **Email Notifications:** subscription-, invoice- and payment-related notifications for the customer.
          example: null
        vat_number_prefix:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
            Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
            ).</p>
            <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
            in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
            the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
            That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
            The first two characters of the VAT number in such a case is
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
            Set
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
            to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
            for such cases.</p>
          maxLength: 10
          example: null
        entity_identifier_scheme:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
            of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
            is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
            is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
            See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
            .</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
            <span featureId="cb-einvoicing" isMicro="true"></span>
          maxLength: 50
          example: null
        entity_identifier_standard:
          type: string
          default: iso6523-actorid-upis
          deprecated: false
          description: |-
            <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
            Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
            is supported and is used by default when not provided.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</p></div>
            <span featureId="cb-einvoicing" isMicro="true"></span>
          maxLength: 50
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for a customer.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
                \* not_validated -

                Address is not yet validated.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        referral_urls:
          type: array
          deprecated: false
          description: |
            List of referral urls for the customer (if applicable)
          items:
            type: object
            deprecated: false
            properties:
              external_customer_id:
                type: string
                deprecated: false
                description: |
                  External customer id in the referral system
                maxLength: 100
                example: null
              referral_sharing_url:
                type: string
                deprecated: false
                description: |
                  Referral sharing url for the customer
                maxLength: 50
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The referral url creation time
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The referral url updation time
                example: null
              referral_campaign_id:
                type: string
                deprecated: false
                description: |
                  Referral campaign id
                maxLength: 50
                example: null
              referral_account_id:
                type: string
                deprecated: false
                description: |
                  Referral account id
                maxLength: 50
                example: null
              referral_external_campaign_id:
                type: string
                deprecated: false
                description: |
                  Referral external campaign id
                maxLength: 50
                example: null
              referral_system:
                type: string
                deprecated: false
                description: |
                  Url for the referral system account
                  \* referral_saasquatch -

                  Referral Saasquatch
                  \* friendbuy -

                  Friendbuy
                  \* referral_candy -

                  Referral Candy
                enum:
                - referral_candy
                - referral_saasquatch
                - friendbuy
                example: null
            required:
            - created_at
            - referral_account_id
            - referral_campaign_id
            - referral_sharing_url
            - referral_system
            - updated_at
            example: null
          example: null
        contacts:
          type: array
          deprecated: false
          description: |
            contacts
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Unique reference ID provided for the contact.
                maxLength: 150
                example: null
              first_name:
                type: string
                deprecated: false
                description: |
                  First name of the contact.
                maxLength: 150
                example: null
              last_name:
                type: string
                deprecated: false
                description: |
                  Last name of the contact.
                maxLength: 150
                example: null
              email:
                type: string
                format: email
                deprecated: false
                description: |
                  Email of the contact.
                maxLength: 70
                example: null
              phone:
                type: string
                deprecated: false
                description: |
                  Phone number of the contact.
                maxLength: 50
                example: null
              label:
                type: string
                deprecated: false
                description: |
                  Label/Tag provided for contact.
                maxLength: 50
                example: null
              enabled:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Contact enabled / disabled
                example: null
              send_account_email:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Whether Account Emails option is enabled for the contact.
                example: null
              send_billing_email:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Whether Billing Emails option is enabled for the contact.
                example: null
            required:
            - email
            - enabled
            - id
            - send_account_email
            - send_billing_email
            example: null
          example: null
        payment_method:
          type: object
          deprecated: false
          description: |
            Primary Payment Source of the customer.
          properties:
            type:
              type: string
              deprecated: false
              description: "Type of payment source\n\\* grab_pay -\n\nPayments made\
                \ via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay\
                \ -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments\
                \ made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank\
                \ -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\\
                * twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\
                \nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made\
                \ via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\\
                * giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\n\
                Represents bank account for which the direct debit or ACH agreement/mandate\
                \ is created.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\
                \\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via\
                \ Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\
                \\* alipay -\n\nPayments made via Alipay.  \nThis payment source is\
                \ deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to\
                \ -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via\
                \ PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay\
                \ -\n\nPayments made via WeChat Pay.  \nThis payment source is deprecated.\n\
                \\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\
                \\* dotpay -\n\nPayments made via Dotpay.\n\\* paypal_express_checkout\
                \ -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\n\
                Payments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic\
                \ Payment Standard\n\\* generic -\n\nPayments made via Generic Payment\
                \ Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\
                \\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish\
                \ -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\
                \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\
                \\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer\
                \ -\n\nRepresents virtual bank account using which the payment will\
                \ be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\
                \\* card -\n\nCard based payment including credit cards and debit\
                \ cards. Details about the card can be obtained from the card resource.\n\
                \\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\
                \\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment\
                \ Button\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n"
              enum:
              - card
              - paypal_express_checkout
              - amazon_payments
              - direct_debit
              - generic
              - alipay
              - unionpay
              - apple_pay
              - wechat_pay
              - ideal
              - google_pay
              - sofort
              - bancontact
              - giropay
              - dotpay
              - upi
              - netbanking_emandates
              - venmo
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - automated_bank_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              example: null
            gateway:
              type: string
              deprecated: false
              description: "Name of the gateway the payment method is associated with.\n\
                \\* ecentric -\n\nEcentric provides a seamless payment processing\
                \ service in South Africa specializing on omnichannel capabilities.\n\
                \\* paypal_payflow_pro -\n\nPayPal Payflow Pro is a payment gateway.\n\
                \\* sage_pay -\n\nSage Pay is a payment gateway.\n\\* wepay -\n\n\
                WePay is a payment gateway.\n\\* wirecard -\n\nWireCard Account is\
                \ a payment service provider.\n\\* migs -\n\nMasterCard Internet Gateway\
                \ Service payment gateway.\n\\* ebanx -\n\nEBANX is a payment gateway,\
                \ enabling businesses to accept diverse local payment methods from\
                \ various countries for increased market reach and conversion.\n\\\
                * beanstream -\n\nBambora(formerly known as Beanstream) is a payment\
                \ gateway.\n\\* adyen -\n\nAdyen is a payment gateway.\n\\* razorpay\
                \ -\n\nRazorpay is a fast growing payment service provider in India\
                \ working with all leading banks and support for major local payment\
                \ methods including Netbanking, UPI etc.\n\\* braintree -\n\nBraintree\
                \ is a payment gateway.\n\\* nmi -\n\nNMI is a payment gateway.\n\\\
                * chargebee_payments -\n\nChargebee Payments gateway\n\\* bluepay\
                \ -\n\nBluePay is a payment gateway.\n\\* paypal -\n\nPayPal Commerce\
                \ is a payment gateway.\n\\* bank_of_america -\n\nBank of America\
                \ Gateway\n\\* paypal_pro -\n\nPayPal Pro Account is a payment gateway.\n\
                \\* eway_rapid -\n\neWAY Rapid is a payment gateway.\n\\* nuvei -\n\
                \nNuvei is a secure and reliable payment processing solution that\
                \ allows you to accept payments from customers and suitable for various\
                \ types of businesses.  \nThis feature is a **Private Beta Release**\
                \ . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
                \ to enable Nuvei for your test and live sites.\n\\* windcave -\n\n\
                Windcave provides an end to end payment processing solution in ANZ\
                \ and other leading global markets.\n\\* dlocal -\n\nDlocal provides\
                \ payment solutions for global commerce by accepting local payment\
                \ methods.\n\\* moneris_us -\n\nMoneris USA is a payment gateway.\n\
                \\* exact -\n\nExact Payments is a payment gateway.\n\\* paypal_express_checkout\
                \ -\n\nPayPal Express Checkout is a payment gateway.\n\\* tco -\n\n\
                2Checkout is a payment gateway.\n\\* pay_com -\n\nPay.com provides\
                \ payment services focused on simplicity and hassle-free operations\
                \ for businesses of all sizes.\n\\* chargebee -\n\nChargebee test\
                \ gateway.\n\\* stripe -\n\nStripe is a payment gateway.\n\\* eway\
                \ -\n\neWAY Account is a payment gateway.\n\\* authorize_net -\n\n\
                Authorize.net is a payment gateway\n\\* moneris -\n\nMoneris is a\
                \ payment gateway.\n\\* worldpay -\n\nWorldPay is a payment gateway\n\
                \\* pin -\n\nPin is a payment gateway\n\\* gocardless -\n\nGoCardless\
                \ is a payment service provider.\n\\* elavon -\n\nElavon Virtual Merchant\
                \ is a payment solution.\n\\* cybersource -\n\nCyberSource is a payment\
                \ gateway.\n\\* vantiv -\n\nVantiv is a payment gateway.\n\\* amazon_payments\
                \ -\n\nAmazon Payments is a payment service provider.\n\\* global_payments\
                \ -\n\nGlobal Payments is a payment service provider.\n\\* first_data_global\
                \ -\n\nFirst Data Global Gateway Virtual Terminal Account\n\\* paystack\
                \ -\n\nPaystack is a payment gateway for businesses in Africa. It\
                \ enables secure payment acceptance both online and offline.  \nThis\
                \ feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
                \ to enable Paystack for your test and live sites.\n\\* orbital -\n\
                \nChase Paymentech(Orbital) is a payment gateway.\n\\* checkout_com\
                \ -\n\nCheckout.com is a payment gateway.\n\\* quickbooks -\n\nIntuit\
                \ QuickBooks Payments gateway\n\\* mollie -\n\nMollie is a payment\
                \ gateway.\n\\* bluesnap -\n\nBlueSnap is a payment gateway.\n\\*\
                \ paymill -\n\nPAYMILL is a payment gateway.\n\\* twikey -\n\nTwikey\
                \ is a payment service provider that specializes in processing direct\
                \ debit payments across the EU.\n\\* ogone -\n\nIngenico ePayments\
                \ (formerly known as Ogone) is a payment gateway.\n\\* not_applicable\
                \ -\n\nIndicates that payment gateway is not applicable for this resource.\n\
                \\* hdfc -\n\nHDFC Account is a payment gateway.\n\\* balanced_payments\
                \ -\n\nBalanced is a payment gateway\n\\* ingenico_direct -\n\nWorldline\
                \ Online Payments is a payment gateway.\n\\* metrics_global -\n\n\
                Metrics global is a leading payment service provider providing unified\
                \ payment services in the US.\n"
              enum:
              - chargebee
              - chargebee_payments
              - adyen
              - stripe
              - wepay
              - braintree
              - authorize_net
              - paypal_pro
              - pin
              - eway
              - eway_rapid
              - worldpay
              - balanced_payments
              - beanstream
              - bluepay
              - elavon
              - first_data_global
              - hdfc
              - migs
              - nmi
              - ogone
              - paymill
              - paypal_payflow_pro
              - sage_pay
              - tco
              - wirecard
              - amazon_payments
              - paypal_express_checkout
              - gocardless
              - orbital
              - moneris_us
              - moneris
              - bluesnap
              - cybersource
              - vantiv
              - checkout_com
              - paypal
              - ingenico_direct
              - exact
              - mollie
              - quickbooks
              - razorpay
              - global_payments
              - bank_of_america
              - ecentric
              - metrics_global
              - windcave
              - pay_com
              - ebanx
              - dlocal
              - nuvei
              - solidgate
              - paystack
              - jp_morgan
              - deutsche_bank
              - ezidebit
              - twikey
              - tempus
              - moyasar
              - payway
              - not_applicable
              example: null
            gateway_account_id:
              type: string
              deprecated: false
              description: |
                The gateway account this payment method is stored with.
              maxLength: 50
              example: null
            status:
              type: string
              default: valid
              deprecated: false
              description: |
                Current status of the payment source.
                \* expired -

                A payment source that has expired
                \* invalid -

                The billing agreement cannot be used. It might become valid again either automatically or due to customer action.
                \* valid -

                A payment source that is valid and active.
                \* pending_verification -

                The payment source needs to be verified
                \* expiring -

                A payment source that is expiring (like card's status based on its expiry date).
              enum:
              - valid
              - expiring
              - expired
              - invalid
              - pending_verification
              example: null
            reference_id:
              type: string
              deprecated: false
              description: |
                The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource.
                **Note:**
                This is not the one time temporary token provided by gateways like Stripe.
              maxLength: 200
              example: null
          required:
          - gateway
          - reference_id
          - status
          - type
          example: null
        balances:
          type: array
          deprecated: false
          description: |
            The list of balances for this customer
          items:
            type: object
            deprecated: false
            properties:
              promotional_credits:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Promotional credits balance of this customer.
                minimum: 0
                example: null
              excess_payments:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Total unused payments associated with the customer.
                minimum: 0
                example: null
              refundable_credits:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Refundable credits balance of this customer
                minimum: 0
                example: null
              unbilled_charges:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Total unbilled charges for this customer.
                minimum: 0
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) for balance
                maxLength: 3
                example: null
              business_entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
            required:
            - currency_code
            - excess_payments
            - promotional_credits
            - refundable_credits
            - unbilled_charges
            example: null
          example: null
        entity_identifiers:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">Each element of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code>
            array identifies a specific customer entity with the e-invoicing system. If the customer has only one entity identifier whose <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">value</code>
            is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>
            , then this array is not needed as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>
            can be provided via <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>.
            This array holds any additional entity identifiers that the customer may have.</p>
            <span featureId="cb-einvoicing" isMicro="true"></span>
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The unique id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                  in Chargebee. When not provided, it is autogenerated.</p>
                maxLength: 40
                example: null
              value:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>.
                  This identifies the customer entity on the Peppol network. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">10101010-STO-10</code>
                  .</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                maxLength: 50
                example: null
              scheme:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code>
                  of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code>
                  is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code>
                  is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.
                  See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a>
                  .</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                maxLength: 50
                example: null
              standard:
                type: string
                default: iso6523-actorid-upis
                deprecated: false
                description: |-
                  <p class="mb-2">The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                  <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>.
                  Currently, only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code>
                  is supported and is used by default when not provided.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip:</strong></p><p class="mb-2">If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</p></div>
                maxLength: 50
                example: null
            required:
            - id
            - scheme
            example: null
          example: null
        tax_providers_fields:
          type: array
          deprecated: false
          description: |
            This represents information related to custom [Tax Provider Fields](/docs/api/subscriptions).
            It includes the provider name, field Id, and its corresponding field value. It is used to send custom Tax provider fields to any tax provider.
          items:
            type: object
            deprecated: false
            properties:
              provider_name:
                type: string
                deprecated: false
                description: |
                  Name of the tax vendor currently we support.
                maxLength: 50
                example: null
              field_id:
                type: string
                deprecated: false
                description: |
                  Field id of the attribute which tax vendor has provided while getting onboarded with us.
                maxLength: 50
                example: null
              field_value:
                type: string
                deprecated: false
                description: |
                  Field value of the corresponding tax field.
                maxLength: 50
                example: null
            required:
            - field_id
            - field_value
            - provider_name
            example: null
          example: null
        relationship:
          type: object
          deprecated: false
          description: |
            The \[account hierarchy\](https://www.chargebee.com/docs/1.0/account-hierarchy.html) relationship that the customer is part of.
          properties:
            parent_id:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                of the immediate parent of this customer under account hierarchy. If the customer is the root of the hierarchy, this attribute isn&#x27;t returned.</p>
              maxLength: 50
              example: null
            payment_owner_id:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                of the customer responsible for paying the invoices for this customer. This ID must match either this customer&#x27;s ID or the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_owner_id</code>
                .</p>
              maxLength: 50
              example: null
            invoice_owner_id:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                of the customer who receives the invoice for charges incurred by the customer. This ID must match either this customer or one of its ancestors.</p>
              maxLength: 50
              example: null
          required:
          - invoice_owner_id
          - payment_owner_id
          example: null
        parent_account_access:
          type: object
          deprecated: false
          description: |-
            <p class="mb-2">When the customer is part of an <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html" target="_blank">account hierarchy</a>, this attribute defines the level of access that the parent account has to the customer&#x27;s information.
            <strong class="font-semibold">Note:</strong>
            the &#x27;parent&#x27; is the customer whose id is <a href="/docs/api/v2/pcv-1/customers/customer-object#relationship_payment_owner_id">payment_owner_id</a>.
            However, if the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_owner_id</code>
            is the customer itself, then the parent is <a href="/docs/api/v2/pcv-1/customers/customer-object#relationship_parent_id">parent_id</a>
            .</p>
          properties:
            portal_edit_child_subscriptions:
              type: string
              deprecated: false
              description: |
                Determines the parent's access to the child's subscriptions in the Self-Serve Portal.
                \* no -

                The parent can't view or edit the child's subscriptions.
                \* view_only -

                The parent can only view the child's subscriptions.
                \* yes -

                The parent can view and edit the child's subscriptions.
              enum:
              - "yes"
              - view_only
              - "no"
              example: null
            portal_download_child_invoices:
              type: string
              deprecated: false
              description: |
                Determines the parent's access to the child's invoices in the Self-Serve Portal.
                \* no -

                The parent can't view or download the child's invoices.
                \* yes -

                The parent can both view and download the child's invoices.
                \* view_only -

                The parent can view but not download the child's invoices.
              enum:
              - "yes"
              - view_only
              - "no"
              example: null
            send_subscription_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether the parent receives email notifications for the child's subscriptions.
              example: null
            send_invoice_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether the parent receives email notifications for the child's invoices.
              example: null
            send_payment_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether, the parent receives email notifications for payment-related activities on the child's invoices.
              example: null
          required:
          - send_invoice_emails
          - send_payment_emails
          - send_subscription_emails
          example: null
        child_account_access:
          type: object
          deprecated: false
          description: |
            When the customer is part of an \[account hierarchy\](https://www.chargebee.com/docs/1.0/account-hierarchy.html) , this attribute defines the level of access that the customer has to its own information.
          properties:
            portal_edit_subscriptions:
              type: string
              deprecated: false
              description: |
                Determines the child's access to its own subscriptions in the Self-Serve Portal.
                \* yes -

                The child account can view and edit its subscriptions.
                \* view_only -

                The child account can only view its subscriptions.
              enum:
              - "yes"
              - view_only
              example: null
            portal_download_invoices:
              type: string
              deprecated: false
              description: |
                Determines the child's access to its own invoices in the Self-Serve Portal.
                \* view_only -

                The child account can view but not download its invoices.
                \* yes -

                The child account can both view and download its invoices.
                \* no -

                The child account cannot view or download its own invoices.
              enum:
              - "yes"
              - view_only
              - "no"
              example: null
            send_subscription_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether the child account receives email notifications for its subscriptions.
              example: null
            send_invoice_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether the child account receives email notifications for its invoices.
              example: null
            send_payment_emails:
              type: boolean
              deprecated: false
              description: |
                Determines whether the child account receives email notifications for payment-related activities for its invoices.
              example: null
          required:
          - send_invoice_emails
          - send_payment_emails
          - send_subscription_emails
          example: null
      required:
      - allow_direct_debit
      - auto_collection
      - created_at
      - deleted
      - excess_payments
      - id
      - net_term_days
      - promotional_credits
      - refundable_credits
      - unbilled_charges
      example: null
    CustomerChangedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CustomerCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CustomerDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            subscriptions:
              type: array
              items:
                $ref: "#/components/schemas/Subscription"
              example: null
          required:
          - card
          - customer
          - subscriptions
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CustomerMovedInEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CustomerMovedOutEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    CustomerType:
      type: string
      deprecated: false
      enum:
      - residential
      - business
      - senior_citizen
      - industrial
      example: null
    DedupeOption:
      type: string
      deprecated: true
      enum:
      - skip
      - update_existing
      example: null
    DirectDebitScheme:
      type: string
      deprecated: false
      enum:
      - ach
      - bacs
      - sepa_core
      - autogiro
      - becs
      - becs_nz
      - pad
      - not_applicable
      example: null
    DiscountType:
      type: string
      deprecated: false
      enum:
      - fixed_amount
      - percentage
      - price
      example: null
    DispositionType:
      type: string
      default: attachment
      deprecated: false
      enum:
      - attachment
      - inline
      example: null
    Download:
      type: object
      description: <div class="api-description"><p class="mb-2">Requesting to download
        a file through this API will return the <code class="bg-gray-100 text-gray-800
        font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono
        whitespace-nowrap">download_url</code> attribute as the response. This attribute
        will contain a URL that will allow the requested content to be downloaded.</p></div>
      properties:
        download_url:
          type: string
          deprecated: false
          description: |
            The URL at which the file is available for download.
          maxLength: 3500
          example: null
        valid_till:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The time until which the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">download_url</code>
            is valid.</p>
          example: null
        mime_type:
          type: string
          deprecated: false
          description: |
            The [media type](https://en.wikipedia.org/wiki/Media_type)
            of the file.
          maxLength: 100
          example: null
      required:
      - download_url
      - valid_till
      example: null
    DunningType:
      type: string
      default: auto_collect
      deprecated: false
      enum:
      - auto_collect
      - offline
      - direct_debit
      example: null
    DunningUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    DurationType:
      type: string
      default: forever
      deprecated: false
      enum:
      - one_time
      - forever
      - limited_period
      example: null
    EInvoicingCountry:
      type: object
      properties:
        country:
          type: string
          deprecated: false
          maxLength: 30
          example: null
        external_id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        status:
          type: string
          default: draft
          deprecated: false
          enum:
          - draft
          - active
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - country
      - created_at
      - modified_at
      - status
      example: null
    EInvoicingCountryRule:
      type: object
      properties:
        model:
          type: string
          deprecated: false
          enum:
          - peppol
          - zugferd
          - einvoice
          - clearance
          - reporting
          - ctc
          - nemhandel
          - face
          - verifactu
          example: null
        transaction_type:
          type: string
          deprecated: false
          enum:
          - b2b
          - b2c
          - b2g
          example: null
        status:
          type: string
          default: draft
          deprecated: false
          enum:
          - draft
          - active
          example: null
        entity_type:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        step:
          type: string
          deprecated: false
          enum:
          - routing_config
          - field_mapping
          - completed
          example: null
        routing_config:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        field_mapping:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - modified_at
      - status
      example: null
    EcheckType:
      type: string
      deprecated: false
      enum:
      - web
      - ppd
      - ccd
      example: null
    Einvoice:
      type: object
      description: |
        Represents the e-invoice record associated with an invoice, including its processing status, reference number (such as one assigned by the IRP), and related status messages.
      properties:
        id:
          type: string
          deprecated: false
          description: <p class="mb-2">The unique <code class="bg-gray-100 text-gray-800
            font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm
            font-mono whitespace-nowrap">id</code> for the e-invoice. This is auto-generated
            by Chargebee.</p>
          maxLength: 50
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            Identifier returned by the connected e-invoicing provider for this submission (for example, a document submission id). Chargebee uses this value when communicating with the provider to retrieve submission status and related artifacts.
          maxLength: 50
          example: null
        reference_number:
          type: string
          deprecated: false
          description: |
            This attribute is used to populate the unique reference number assigned to an invoice on the Invoice Registration Portal (IRP) network. It is essential for identifying and tracking invoices that are processed through the IRP network.

            In the future, this field may be used to store similar reference numbers for other networks.
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code>.</p>
            * failed - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered.</p>
            * in_progress - <p class="mb-2">The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.</p>
            * success - <p class="mb-2">The e-invoice has been successfully delivered to the customer.</p>
            * scheduled - <p class="mb-2">Sending the e-invoice to the customer has been scheduled.</p>
            * registered - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.</p>
            * skipped - <p class="mb-2">The e-invoice was not sent. This could be due to missing information or because the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code> is not registered on the e-invoicing network.</p>
          enum:
          - scheduled
          - skipped
          - in_progress
          - success
          - failed
          - registered
          - accepted
          - rejected
          - message_acknowledgement
          - in_process
          - under_query
          - conditionally_accepted
          - paid
          example: null
        message:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Detailed information about the status of the e-invoice. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skipped</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code>, this contains the reason or error details. The following are some valid examples:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Invoice successfully sent to customer via the e-invoicing network 9090:123456</li>
            <li class="text-base leading-relaxed">Invoice successfully sent to customer via email id abc@acme.com</li>
            </ul>
          maxLength: 3000
          example: null
        provider_references:
          type: array
          deprecated: false
          items:
            example: null
          example: null
      required:
      - id
      - status
      example: null
    EinvoicingMethod:
      type: string
      deprecated: false
      enum:
      - automatic
      - manual
      - site_default
      example: null
    EndScheduleOn:
      type: string
      deprecated: false
      enum:
      - after_number_of_intervals
      - specific_date
      - subscription_end
      example: null
    EntitlementVersion:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan
          - addon
          - charge
          - plan_price
          - addon_price
          example: null
        feature_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        change_reason:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        version:
          type: integer
          format: int64
          deprecated: false
          example: null
      required:
      - id
      example: null
    EntityCode:
      type: string
      deprecated: false
      enum:
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - j
      - k
      - l
      - m
      - "n"
      - p
      - q
      - r
      - med1
      - med2
      example: null
    EntityType:
      type: string
      deprecated: false
      enum:
      - plan
      - addon
      - customer
      - subscription
      - coupon
      - invoice
      - quote
      - credit_note
      - transaction
      - order
      - plan_item
      - addon_item
      - charge_item
      - plan_price
      - addon_price
      - charge_price
      - differential_price
      - attached_item
      - feature
      - subscription_entitlement
      - item_entitlement
      - business_entity
      - omnichannel_subscription
      - omnichannel_subscription_item
      - omnichannel_transaction
      - recorded_purchase
      - omnichannel_subscription_item_scheduled_change
      - sales_order
      - omnichannel_one_time_order
      - omnichannel_one_time_order_item
      - usage_file
      - business_rule
      - ruleset
      - alert_status
      - charge
      example: null
    Estimate:
      type: object
      description: "During the process of signing up customers to subscriptions, use\
        \ the Estimates API to evaluate the details of the purchase before actually\
        \ signing them up. The details returned by the API include the invoice amounts,\
        \ next billing date and unbilled charges.\n\nFor example, consider that you\
        \ are creating a new subscription or update an existing one. Use the Estimates\
        \ API before that to deduce the details such as the amount the customer would\
        \ be charged, the state the subscription would be in after creation or updation,\
        \ and so on.  \nIf you have configured the [Avalara integration](https://www.chargebee.com/docs/1.0/avalara.html),\
        \ Chargebee retrieves the tax amount from Avalara for the invoice. This counts\
        \ against your Avalara API limits.\n"
      properties:
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this estimate got generated
          example: null
        subscription_estimate:
          type: object
          deprecated: false
          description: |
            Represents the subscription details when the 'estimate' operations are invoked.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                The identifier of the subscription
              maxLength: 50
              example: null
            currency_code:
              type: string
              deprecated: false
              description: |
                The currency code (ISO 4217 format) of the subscription.
              maxLength: 3
              example: null
            status:
              type: string
              deprecated: false
              description: |
                The status of the subscription.
                \* in_trial -

                The subscription is in trial.
                \* paused -

                The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).
                The subscription will not renew while in this state.
                \* transferred -

                The subscription has been transferred to another business entity within the organization.
                \* cancelled -

                The subscription has been canceled and is no longer in service.
                \* non_renewing -

                The subscription will be canceled at the end of the current term.
                \* future -

                The subscription is scheduled to start at a future date.
                \* active -

                The subscription is active and will be charged for automatically based on the items in it.
              enum:
              - future
              - in_trial
              - active
              - non_renewing
              - paused
              - cancelled
              - transferred
              example: null
            trial_end_action:
              type: string
              deprecated: false
              description: |
                Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
                \* site_default -

                This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                at the time when the trial ends, takes effect.
                \* activate_subscription -

                The subscription activates and charges are raised for non-metered items.
                \* cancel_subscription -

                The subscription cancels.
                \* plan_default -

                The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                at the time when the trial ends, takes effect.
              enum:
              - site_default
              - plan_default
              - activate_subscription
              - cancel_subscription
              example: null
            next_billing_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.
              example: null
            pause_date:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The date on which subscription will be paused. Applicable only to paused or scheduled pause subscriptions
              example: null
            resume_date:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The date on which subscription will be resumed. Applicable only to paused or scheduled pause subscriptions
              example: null
            shipping_address:
              type: object
              deprecated: false
              description: |
                Represents the shipping address when the 'estimate' operations are invoked.
              properties:
                first_name:
                  type: string
                  deprecated: false
                  description: |
                    The first name of the contact.
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: |
                    The last name of the contact.
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: |
                    The email address.
                  maxLength: 70
                  example: null
                company:
                  type: string
                  deprecated: false
                  description: |
                    The company name.
                  maxLength: 250
                  example: null
                phone:
                  type: string
                  deprecated: false
                  description: |
                    The phone number.
                  maxLength: 50
                  example: null
                line1:
                  type: string
                  deprecated: false
                  description: |
                    Address line 1
                  maxLength: 150
                  example: null
                line2:
                  type: string
                  deprecated: false
                  description: |
                    Address line 2
                  maxLength: 150
                  example: null
                line3:
                  type: string
                  deprecated: false
                  description: |
                    Address line 3
                  maxLength: 150
                  example: null
                city:
                  type: string
                  deprecated: false
                  description: |
                    The name of the city.
                  maxLength: 50
                  example: null
                state_code:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                    without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                    as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                    ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                    ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                    (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                    ).</p>
                  maxLength: 50
                  example: null
                state:
                  type: string
                  deprecated: false
                  description: |
                    The state/province name.
                  maxLength: 50
                  example: null
                country:
                  type: string
                  deprecated: false
                  description: |-
                    <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                    .</p>
                    <p class="mb-2"><strong class="font-semibold">Note</strong>:
                    If you enter an invalid country code, the system will return an error.</p>
                    <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                  maxLength: 50
                  example: null
                zip:
                  type: string
                  deprecated: false
                  description: |
                    Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                    .
                  maxLength: 20
                  example: null
                validation_status:
                  type: string
                  default: not_validated
                  deprecated: false
                  description: |
                    The address verification status.
                    \* invalid -

                    Address is invalid.
                    \* partially_valid -

                    The address is valid for taxability but has not been validated for shipping.
                    \* valid -

                    Address was validated successfully.
                    \* not_validated -

                    Address is not yet validated.
                  enum:
                  - not_validated
                  - valid
                  - partially_valid
                  - invalid
                  example: null
              example: null
            contract_term:
              type: object
              deprecated: false
              description: |
                Represents the contract terms when the 'estimate' operations are invoked.
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Id that uniquely identifies the contract term in the site.
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Current status of contract
                    \* terminated -

                    The contract term was terminated ahead of completion.
                    \* cancelled -

                    The contract term was ended because: - a change in the subscription caused a [subscription term reset](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#force_term_reset).

                    * the subscription was cancelled due to non-payment.

                    \* active -

                    An actively running contract term.
                    \* completed -

                    The contract term has run its full duration.
                  enum:
                  - active
                  - completed
                  - cancelled
                  - terminated
                  example: null
                contract_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The start date of the contract term
                  example: null
                contract_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The end date of the contract term
                  example: null
                billing_cycle:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of billing cycles of the subscription that the contract term is for.
                  minimum: 0
                  example: null
                action_at_term_end:
                  type: string
                  default: renew
                  deprecated: false
                  description: |-
                    <p class="mb-2">Action to be taken when the contract term completes.</p>
                    * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                    <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                    </ul>
                    * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                    * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                    <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                    <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                    </ul>
                    * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                  enum:
                  - renew
                  - evergreen
                  - cancel
                  - renew_once
                  example: null
                total_contract_value:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |-
                    <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
                    of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                    contract terms, this is a predicted value. The value depends on the <a href="/docs/api/v2/pcv-1/estimates">type of currency</a>.
                    If the subscription was <a href="/docs/api/v2/pcv-1/estimates">imported</a>
                    with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
                    .</p>
                  minimum: 0
                  example: null
                total_contract_value_before_tax:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |-
                    <p class="mb-2">It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised_before_tax</code>
                    is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.</p>
                  minimum: 0
                  example: null
                cancellation_cutoff_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                    , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                  example: null
                created_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date when the contract term was created.
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The [Id](/docs/api/subscriptions/subscription-object#id)
                    of the subscription that this contract term is for.
                  maxLength: 50
                  example: null
                remaining_billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |-
                    <p class="mb-2">The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                    contract terms.</p>
                  minimum: 0
                  example: null
              required:
              - action_at_term_end
              - billing_cycle
              - contract_end
              - contract_start
              - created_at
              - id
              - status
              - subscription_id
              - total_contract_value
              - total_contract_value_before_tax
              example: null
          required:
          - currency_code
          example: null
        subscription_estimates:
          type: array
          deprecated: false
          description: |
            Is a list of estimated subscriptions i.e., an array of *subscription_estimate*
            objects. It is generated when 'Create an estimate for purchase' operation is invoked
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  The identifier of the subscription
                maxLength: 50
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the subscription.
                maxLength: 3
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  The status of the subscription.
                  \* future -

                  The subscription is scheduled to start at a future date.
                  \* transferred -

                  The subscription has been transferred to another business entity within the organization.
                  \* in_trial -

                  The subscription is in trial.
                  \* active -

                  The subscription is active and will be charged for automatically based on the items in it.
                  \* non_renewing -

                  The subscription will be canceled at the end of the current term.
                  \* cancelled -

                  The subscription has been canceled and is no longer in service.
                  \* paused -

                  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).
                  The subscription will not renew while in this state.
                enum:
                - future
                - in_trial
                - active
                - non_renewing
                - paused
                - cancelled
                - transferred
                example: null
              trial_end_action:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Applicable only when <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">End-of-trial Action</a>
                  has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.</p>
                  * site_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a>
                  at the time when the trial ends, takes effect. This is the default value when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end_action</code>
                  is <strong class="font-semibold">not</strong>
                  defined for the plan.</p>
                  * plan_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a>
                  at the time when the trial ends, takes effect. This is the default value when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_end_action</code>
                  is defined for the plan.</p>
                  * cancel_subscription - <p class="mb-2">The subscription cancels.</p>
                  * activate_subscription - <p class="mb-2">The subscription activates and charges are raised for non-metered items.</p>
                enum:
                - site_default
                - plan_default
                - activate_subscription
                - cancel_subscription
                example: null
              next_billing_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.
                example: null
              pause_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date on which subscription will be paused. Applicable only to paused or scheduled pause subscriptions
                example: null
              resume_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date on which subscription will be resumed. Applicable only to paused or scheduled pause subscriptions
                example: null
              shipping_address:
                type: object
                deprecated: false
                description: |
                  Represents the shipping address when the 'estimate' operations are invoked.
                properties:
                  first_name:
                    type: string
                    deprecated: false
                    description: |
                      The first name of the contact.
                    maxLength: 150
                    example: null
                  last_name:
                    type: string
                    deprecated: false
                    description: |
                      The last name of the contact.
                    maxLength: 150
                    example: null
                  email:
                    type: string
                    format: email
                    deprecated: false
                    description: |
                      The email address.
                    maxLength: 70
                    example: null
                  company:
                    type: string
                    deprecated: false
                    description: |
                      The company name.
                    maxLength: 250
                    example: null
                  phone:
                    type: string
                    deprecated: false
                    description: |
                      The phone number.
                    maxLength: 50
                    example: null
                  line1:
                    type: string
                    deprecated: false
                    description: |
                      Address line 1
                    maxLength: 150
                    example: null
                  line2:
                    type: string
                    deprecated: false
                    description: |
                      Address line 2
                    maxLength: 150
                    example: null
                  line3:
                    type: string
                    deprecated: false
                    description: |
                      Address line 3
                    maxLength: 150
                    example: null
                  city:
                    type: string
                    deprecated: false
                    description: |
                      The name of the city.
                    maxLength: 50
                    example: null
                  state_code:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                      as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                      ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                      ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                      ).</p>
                    maxLength: 50
                    example: null
                  state:
                    type: string
                    deprecated: false
                    description: |
                      The state/province name.
                    maxLength: 50
                    example: null
                  country:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                      .</p>
                      <p class="mb-2"><strong class="font-semibold">Note</strong>:
                      If you enter an invalid country code, the system will return an error.</p>
                      <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
                    maxLength: 50
                    example: null
                  zip:
                    type: string
                    deprecated: false
                    description: |
                      Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                      .
                    maxLength: 20
                    example: null
                  validation_status:
                    type: string
                    default: not_validated
                    deprecated: false
                    description: |
                      The address verification status.
                      \* valid -

                      Address was validated successfully.
                      \* not_validated -

                      Address is not yet validated.
                      \* invalid -

                      Address is invalid.
                      \* partially_valid -

                      The address is valid for taxability but has not been validated for shipping.
                    enum:
                    - not_validated
                    - valid
                    - partially_valid
                    - invalid
                    example: null
                example: null
              contract_term:
                type: object
                deprecated: false
                description: |
                  Represents the contract terms when the 'estimate' operations are invoked.
                properties:
                  id:
                    type: string
                    deprecated: false
                    description: |
                      Id that uniquely identifies the contract term in the site.
                    maxLength: 50
                    example: null
                  status:
                    type: string
                    deprecated: false
                    description: |
                      Current status of contract
                      \* active -

                      An actively running contract term.
                      \* completed -

                      The contract term has run its full duration.
                      \* cancelled -

                      The contract term was ended because: - a change in the subscription caused a [subscription term reset](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#force_term_reset).

                      * the subscription was cancelled due to non-payment.

                      \* terminated -

                      The contract term was terminated ahead of completion.
                    enum:
                    - active
                    - completed
                    - cancelled
                    - terminated
                    example: null
                  contract_start:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      The start date of the contract term
                    example: null
                  contract_end:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      The end date of the contract term
                    example: null
                  billing_cycle:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The number of billing cycles of the subscription that the contract term is for.
                    minimum: 0
                    example: null
                  action_at_term_end:
                    type: string
                    default: renew
                    deprecated: false
                    description: |-
                      <p class="mb-2">Action to be taken when the contract term completes.</p>
                      * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                      * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                      <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                      <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                      </ul>
                      * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                      * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                      <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                      <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                      </ul>
                    enum:
                    - renew
                    - evergreen
                    - cancel
                    - renew_once
                    example: null
                  total_contract_value:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |-
                      <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
                      of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                      contract terms, this is a predicted value. The value depends on the <a href="/docs/api/v2/pcv-1/estimates">type of currency</a>.
                      If the subscription was <a href="/docs/api/v2/pcv-1/estimates">imported</a>
                      with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
                      .</p>
                    minimum: 0
                    example: null
                  total_contract_value_before_tax:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |-
                      <p class="mb-2">It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised_before_tax</code>
                      is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.</p>
                    minimum: 0
                    example: null
                  cancellation_cutoff_period:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |-
                      <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                      , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
                    example: null
                  created_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      The date when the contract term was created.
                    example: null
                  subscription_id:
                    type: string
                    deprecated: false
                    description: |
                      The [Id](/docs/api/subscriptions/subscription-object#id)
                      of the subscription that this contract term is for.
                    maxLength: 50
                    example: null
                  remaining_billing_cycles:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |-
                      <p class="mb-2">The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                      contract terms.</p>
                    minimum: 0
                    example: null
                required:
                - action_at_term_end
                - billing_cycle
                - contract_end
                - contract_start
                - created_at
                - id
                - status
                - subscription_id
                - total_contract_value
                - total_contract_value_before_tax
                example: null
            required:
            - currency_code
            example: null
          example: null
        invoice_estimate:
          type: object
          deprecated: false
          description: |
            Represents the preview of the invoice generated immediately when the 'estimate' operations are invoked.
          properties:
            recurring:
              type: boolean
              default: true
              deprecated: false
              description: |
                Whether or not the estimate for the invoice is recurring. Will be 'true' or 'false' for subscription related estimates.
              example: null
            price_type:
              type: string
              default: tax_exclusive
              deprecated: false
              description: |
                The price type of this invoice.
                \* tax_inclusive -

                All amounts in the document are inclusive of tax.
                \* tax_exclusive -

                All amounts in the document are exclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            currency_code:
              type: string
              deprecated: false
              description: |
                The currency code (ISO 4217 format) of the invoice.
              maxLength: 3
              example: null
            sub_total:
              type: integer
              format: int64
              deprecated: false
              description: |
                Invoice sub-total in cents.
              minimum: 0
              example: null
            total:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Invoice total in cents.
              minimum: 0
              example: null
            credits_applied:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                credits applied to this invoice in cents.
              minimum: 0
              example: null
            amount_paid:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Existing outstanding payments if any, applied to this invoice in cents.
              minimum: 0
              example: null
            amount_due:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Invoice amount due in cents
              minimum: 0
              example: null
            line_items:
              type: array
              deprecated: false
              description: |-
                <p class="mb-2">The details of the line items in this invoice estimate.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><p class="mb-2">Line items that meet <strong class="font-semibold">both</strong> the following conditions are <strong class="font-semibold">not</strong> returned:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">The line item belongs to an item price whose parent item is <code><a href="/docs/api/items/item-object#metered">metered</a></code>.</li>
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item.amount</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>.</li>
                </ul></div>
              items:
                type: object
                deprecated: false
                properties:
                  id:
                    type: string
                    deprecated: false
                    description: |
                      Uniquely identifies a line_item
                    maxLength: 40
                    example: null
                  subscription_id:
                    type: string
                    deprecated: false
                    description: |
                      A unique identifier for the subscription this line item belongs to.
                    maxLength: 50
                    example: null
                  date_from:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Start date of this line item.
                    example: null
                  date_to:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      End date of this line item.
                    example: null
                  unit_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Unit amount of the line item.
                    example: null
                  quantity:
                    type: integer
                    format: int32
                    default: 1
                    deprecated: false
                    description: |
                      [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                      which is represented by this line item.
                    example: null
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total amount of this line item. Typically equals to unit amount x quantity
                    example: null
                  pricing_model:
                    type: string
                    deprecated: false
                    description: |
                      The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                      for this item.
                      \* tiered -

                      There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                      \* flat_fee -

                      A fixed price that is not quantity-based.
                      \* stairstep -

                      A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                      \* per_unit -

                      A fixed price per unit quantity.
                      \* volume -

                      The per unit price is based on the tier that the total quantity falls in.
                    enum:
                    - flat_fee
                    - per_unit
                    - tiered
                    - volume
                    - stairstep
                    example: null
                  is_taxed:
                    type: boolean
                    default: false
                    deprecated: false
                    description: |
                      Specifies whether this line item is taxed or not
                    example: null
                  tax_amount:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |
                      The tax amount charged for this item
                    minimum: 0
                    example: null
                  tax_rate:
                    type: number
                    format: double
                    deprecated: false
                    description: |
                      Rate of tax used to calculate tax for this lineitem
                    maximum: 100
                    minimum: 0
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                      The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 39
                    example: null
                  quantity_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                      x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                      Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 39
                    example: null
                  discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total discounts for this line
                    minimum: 0
                    example: null
                  item_level_discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Line Item-level discounts for this line.
                    minimum: 0
                    example: null
                  metered:
                    type: boolean
                    deprecated: false
                    example: null
                  is_percentage_pricing:
                    type: boolean
                    deprecated: false
                    example: null
                  reference_line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Invoice Reference Line Item ID
                    maxLength: 40
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Detailed description about this line item.
                    maxLength: 250
                    example: null
                  entity_description:
                    type: string
                    deprecated: false
                    description: |
                      Detailed description about this item.
                    maxLength: 500
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |
                      Specifies the modelled entity this line item is based on.
                      \* addon_item_price -

                      Indicates that this line item is based on addon Item Price
                      \* plan_item_price -

                      Indicates that this line item is based on plan Item Price
                      \* plan_setup -

                      Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                      id
                      \* plan -

                      Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                      id
                      \* adhoc -

                      Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                      \* charge_item_price -

                      Indicates that this line item is based on charge Item Price
                      \* addon -

                      Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                      id
                    enum:
                    - plan_setup
                    - plan
                    - addon
                    - adhoc
                    example: null
                  tax_exempt_reason:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                      * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                      * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                      * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                      * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                      * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                      * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                      * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                      * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                      * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                      and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                      have not been provided for the customer and subscription respectively</p>
                      * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                    enum:
                    - tax_not_configured
                    - region_non_taxable
                    - export
                    - customer_exempt
                    - product_exempt
                    - zero_rated
                    - reverse_charge
                    - high_value_physical_goods
                    - zero_value_item
                    - tax_not_configured_external_provider
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                    maxLength: 100
                    example: null
                  customer_id:
                    type: string
                    deprecated: false
                    description: |
                      A unique identifier for the customer this line item belongs to
                    maxLength: 100
                    example: null
                required:
                - date_from
                - date_to
                - description
                - entity_type
                - is_taxed
                - unit_amount
                example: null
              example: null
            line_item_tiers:
              type: array
              deprecated: false
              description: |
                The list of tiers applicable for this line item
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Uniquely identifies a line_item
                    maxLength: 40
                    example: null
                  starting_unit:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The lower limit of a range of units for the tier
                    minimum: 0
                    example: null
                  ending_unit:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The upper limit of a range of units for the tier
                    example: null
                  quantity_used:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The number of units purchased in a range.
                    minimum: 0
                    example: null
                  unit_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |-
                      <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                      pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      pricing.</p>
                    minimum: 0
                    example: null
                  starting_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                      of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                      and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  ending_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                      of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  quantity_used_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                      When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                      , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                      The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 40
                    example: null
                  pricing_type:
                    type: string
                    deprecated: false
                    enum:
                    - per_unit
                    - flat_fee
                    - package
                    example: null
                  package_size:
                    type: integer
                    format: int32
                    deprecated: false
                    minimum: 1
                    example: null
                required:
                - quantity_used
                - starting_unit
                - unit_amount
                example: null
              example: null
            line_item_discounts:
              type: array
              deprecated: false
              description: |
                The list of discount(s) applied for each line item of this invoice.
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique id of the line item that this deduction is for.
                    maxLength: 50
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                      * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                      applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case.</p>
                      * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                      .</p>
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    example: null
                  coupon_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a coupon, then this is the id of the coupon.
                    maxLength: 50
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                      .
                    minimum: 0
                    example: null
                required:
                - discount_amount
                - discount_type
                - line_item_id
                example: null
              example: null
            line_item_taxes:
              type: array
              deprecated: false
              description: |
                The list of taxes applied on line items
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique reference id of the line item for which the tax is applicable
                    maxLength: 40
                    example: null
                  tax_name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax applied
                    maxLength: 100
                    example: null
                  tax_rate:
                    type: number
                    format: double
                    default: 0
                    deprecated: false
                    description: |
                      The rate of tax used to calculate tax amount
                    maximum: 100
                    minimum: 0
                    example: null
                  date_to:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Indicates the service period end of the tax rate for the line item.
                    example: null
                  date_from:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Indicates the service period start of the tax rate for the line item.
                    example: null
                  prorated_taxable_amount:
                    type: number
                    format: decimal
                    deprecated: false
                    description: |
                      Indicates the prorated line item amount in cents
                    maximum: 1000000000
                    minimum: -1000000000
                    example: null
                  is_partial_tax_applied:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates if tax is applied only on a portion of the line item amount.
                    example: null
                  is_non_compliance_tax:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates the non-compliance tax that should not be reported to the jurisdiction.
                    example: null
                  taxable_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Indicates the actual portion of the line item amount that is taxable.
                    minimum: 0
                    example: null
                  tax_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The tax amount
                    minimum: 0
                    example: null
                  tax_juris_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of tax jurisdiction
                      \* city -

                      The tax jurisdiction is a city
                      \* federal -

                      The tax jurisdiction is a federal
                      \* state -

                      The tax jurisdiction is a state
                      \* special -

                      Special tax jurisdiction.
                      \* unincorporated -

                      Combined tax of state and county.
                      \* county -

                      The tax jurisdiction is a county
                      \* country -

                      The tax jurisdiction is a country
                      \* other -

                      Jurisdictions other than the ones listed above.
                    enum:
                    - country
                    - federal
                    - state
                    - county
                    - city
                    - special
                    - unincorporated
                    - other
                    example: null
                  tax_juris_name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax jurisdiction
                    maxLength: 250
                    example: null
                  tax_juris_code:
                    type: string
                    deprecated: false
                    description: |
                      The tax jurisdiction code
                    maxLength: 250
                    example: null
                  tax_amount_in_local_currency:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                    minimum: 0
                    example: null
                  local_currency_code:
                    type: string
                    deprecated: false
                    description: |
                      The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                    maxLength: 3
                    example: null
                required:
                - tax_amount
                - tax_name
                - tax_rate
                - taxable_amount
                example: null
              example: null
            line_item_credits:
              type: array
              deprecated: false
              description: |
                A list of store credits applied to line items.
              items:
                type: object
                deprecated: false
                properties:
                  cn_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique ID of the credit note from which the credit is applied.
                    maxLength: 50
                    example: null
                  applied_amount:
                    type: number
                    format: double
                    default: 0
                    deprecated: false
                    description: |
                      The credit amount is applied to the line item.
                    example: null
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique ID of the line item to which this credit is applied.
                    maxLength: 40
                    example: null
                required:
                - applied_amount
                - cn_id
                example: null
              example: null
            line_item_addresses:
              type: array
              deprecated: false
              description: |
                The list of addresses used for tax calculation on line items.
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Line item reference
                    maxLength: 40
                    example: null
                  first_name:
                    type: string
                    deprecated: false
                    description: |
                      First name of the customer
                    maxLength: 150
                    example: null
                  last_name:
                    type: string
                    deprecated: false
                    description: |
                      Last name of the customer
                    maxLength: 150
                    example: null
                  email:
                    type: string
                    format: email
                    deprecated: false
                    description: |
                      Email of the customer
                    maxLength: 70
                    example: null
                  company:
                    type: string
                    deprecated: false
                    description: |
                      Name of the company
                    maxLength: 250
                    example: null
                  phone:
                    type: string
                    deprecated: false
                    description: |
                      Phone number of the customer
                    maxLength: 50
                    example: null
                  line1:
                    type: string
                    deprecated: false
                    description: |
                      Address line 1
                    maxLength: 150
                    example: null
                  line2:
                    type: string
                    deprecated: false
                    description: |
                      Address line 2
                    maxLength: 150
                    example: null
                  line3:
                    type: string
                    deprecated: false
                    description: |
                      Address line 3
                    maxLength: 150
                    example: null
                  city:
                    type: string
                    deprecated: false
                    description: |
                      Name of the city
                    maxLength: 50
                    example: null
                  state_code:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                      as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                      ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                      ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                      ).</p>
                    maxLength: 50
                    example: null
                  state:
                    type: string
                    deprecated: false
                    description: |
                      State or Province
                    maxLength: 50
                    example: null
                  country:
                    type: string
                    deprecated: false
                    description: "The billing address of the customer, specified as\
                      \ an [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                      Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                      \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                      \ is enabled, 'United Kingdom-Northern Ireland' is a valid option.\n"
                    maxLength: 50
                    example: null
                  zip:
                    type: string
                    deprecated: false
                    description: |
                      Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                      .
                    maxLength: 20
                    example: null
                  validation_status:
                    type: string
                    default: not_validated
                    deprecated: false
                    description: |
                      The address verification status.
                      \* invalid -

                      Address is invalid.
                      \* not_validated -

                      Address is not yet validated.
                      \* valid -

                      Address was validated successfully.
                      \* partially_valid -

                      The address is valid for taxability but has not been validated for shipping.
                    enum:
                    - not_validated
                    - valid
                    - partially_valid
                    - invalid
                    example: null
                example: null
              example: null
            discounts:
              type: array
              deprecated: false
              description: |
                The list of discounts applied to this estimate
              items:
                type: object
                deprecated: false
                properties:
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                      .
                    minimum: 0
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Description for this deduction.
                    maxLength: 250
                    example: null
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                      .</p>
                    maxLength: 40
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                      * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                      .</p>
                      * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                      applied to the invoice.</p>
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    enum:
                    - fixed_amount
                    - percentage
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                      , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      of the coupon.</p>
                    maxLength: 100
                    example: null
                  coupon_set_code:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                      , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                      is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                    maxLength: 50
                    example: null
                required:
                - amount
                - entity_type
                example: null
              example: null
            taxes:
              type: array
              deprecated: false
              description: |
                The list of taxes applied to this estimate
              items:
                type: object
                deprecated: false
                properties:
                  name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax applied. E.g. GST.
                    maxLength: 100
                    example: null
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The tax amount.
                    minimum: 0
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Description of the tax item.
                    maxLength: 250
                    example: null
                required:
                - amount
                - name
                example: null
              example: null
            round_off_amount:
              type: integer
              format: int64
              deprecated: false
              description: |-
                <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
                If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
                , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                .</p>
              minimum: 0
              example: null
            customer_id:
              type: string
              deprecated: false
              description: |
                A unique identifier for the customer this invoice belongs to
              maxLength: 100
              example: null
          required:
          - currency_code
          - price_type
          - recurring
          - sub_total
          example: null
        invoice_estimates:
          type: array
          deprecated: false
          description: |
            Is a list of estimated invoices i.e., an array of *invoice_estimate*
            objects. It is generated when 'Create an estimate for unbilled charges' operation is invoked
          items:
            type: object
            deprecated: false
            properties:
              recurring:
                type: boolean
                default: true
                deprecated: false
                description: |
                  Whether or not the estimate for the invoice is recurring. Will be 'true' or 'false' for subscription related estimates.
                example: null
              price_type:
                type: string
                default: tax_exclusive
                deprecated: false
                description: |
                  The price type of this invoice.
                  \* tax_inclusive -

                  All amounts in the document are inclusive of tax.
                  \* tax_exclusive -

                  All amounts in the document are exclusive of tax.
                enum:
                - tax_exclusive
                - tax_inclusive
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the invoice.
                maxLength: 3
                example: null
              sub_total:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Invoice sub-total in cents.
                minimum: 0
                example: null
              total:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Invoice total in cents.
                minimum: 0
                example: null
              credits_applied:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  credits applied to this invoice in cents.
                minimum: 0
                example: null
              amount_paid:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Existing outstanding payments if any, applied to this invoice in cents.
                minimum: 0
                example: null
              amount_due:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Invoice amount due in cents
                minimum: 0
                example: null
              line_items:
                type: array
                deprecated: false
                description: |-
                  <p class="mb-2">The details of the line items in this invoice estimate.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><p class="mb-2">Line items that meet <strong class="font-semibold">both</strong> the following conditions are <strong class="font-semibold">not</strong> returned:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The line item belongs to an item price whose parent item is <code><a href="/docs/api/items/item-object#metered">metered</a></code>.</li>
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item.amount</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>.</li>
                  </ul></div>
                items:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a line_item
                      maxLength: 40
                      example: null
                    subscription_id:
                      type: string
                      deprecated: false
                      description: |
                        A unique identifier for the subscription this line item belongs to.
                      maxLength: 50
                      example: null
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Start date of this line item.
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End date of this line item.
                      example: null
                    unit_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Unit amount of the line item.
                      example: null
                    quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                        which is represented by this line item.
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total amount of this line item. Typically equals to unit amount x quantity
                      example: null
                    pricing_model:
                      type: string
                      deprecated: false
                      description: |
                        The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                        for this item.
                        \* tiered -

                        There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                        \* per_unit -

                        A fixed price per unit quantity.
                        \* flat_fee -

                        A fixed price that is not quantity-based.
                        \* stairstep -

                        A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                        \* volume -

                        The per unit price is based on the tier that the total quantity falls in.
                      enum:
                      - flat_fee
                      - per_unit
                      - tiered
                      - volume
                      - stairstep
                      example: null
                    is_taxed:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Specifies whether this line item is taxed or not
                      example: null
                    tax_amount:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |
                        The tax amount charged for this item
                      minimum: 0
                      example: null
                    tax_rate:
                      type: number
                      format: double
                      deprecated: false
                      description: |
                        Rate of tax used to calculate tax for this lineitem
                      maximum: 100
                      minimum: 0
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 39
                      example: null
                    quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                        x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                        Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 39
                      example: null
                    discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total discounts for this line
                      minimum: 0
                      example: null
                    item_level_discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Line Item-level discounts for this line.
                      minimum: 0
                      example: null
                    metered:
                      type: boolean
                      deprecated: false
                      example: null
                    is_percentage_pricing:
                      type: boolean
                      deprecated: false
                      example: null
                    reference_line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Invoice Reference Line Item ID
                      maxLength: 40
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Detailed description about this line item.
                      maxLength: 250
                      example: null
                    entity_description:
                      type: string
                      deprecated: false
                      description: |
                        Detailed description about this item.
                      maxLength: 500
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |
                        Specifies the modelled entity this line item is based on.
                        \* plan_item_price -

                        Indicates that this line item is based on plan Item Price
                        \* charge_item_price -

                        Indicates that this line item is based on charge Item Price
                        \* addon_item_price -

                        Indicates that this line item is based on addon Item Price
                        \* plan_setup -

                        Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                        id
                        \* addon -

                        Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                        id
                        \* plan -

                        Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                        id
                        \* adhoc -

                        Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                      enum:
                      - plan_setup
                      - plan
                      - addon
                      - adhoc
                      example: null
                    tax_exempt_reason:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                        * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                        and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                        have not been provided for the customer and subscription respectively</p>
                        * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                        * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                        * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                        * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                        * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                        * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                        * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                        * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                        * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                      enum:
                      - tax_not_configured
                      - region_non_taxable
                      - export
                      - customer_exempt
                      - product_exempt
                      - zero_rated
                      - reverse_charge
                      - high_value_physical_goods
                      - zero_value_item
                      - tax_not_configured_external_provider
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                      maxLength: 100
                      example: null
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        A unique identifier for the customer this line item belongs to
                      maxLength: 100
                      example: null
                  required:
                  - date_from
                  - date_to
                  - description
                  - entity_type
                  - is_taxed
                  - unit_amount
                  example: null
                example: null
              line_item_tiers:
                type: array
                deprecated: false
                description: |
                  The list of tiers applicable for this line item
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a line_item
                      maxLength: 40
                      example: null
                    starting_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The lower limit of a range of units for the tier
                      minimum: 0
                      example: null
                    ending_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The upper limit of a range of units for the tier
                      example: null
                    quantity_used:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of units purchased in a range.
                      minimum: 0
                      example: null
                    unit_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      minimum: 1
                      example: null
                  required:
                  - quantity_used
                  - starting_unit
                  - unit_amount
                  example: null
                example: null
              line_item_discounts:
                type: array
                deprecated: false
                description: |
                  The list of discount(s) applied for each line item of this invoice.
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique id of the line item that this deduction is for.
                      maxLength: 50
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                        * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                        applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case.</p>
                        * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                        * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                        * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                        .</p>
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      example: null
                    coupon_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a coupon, then this is the id of the coupon.
                      maxLength: 50
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      minimum: 0
                      example: null
                  required:
                  - discount_amount
                  - discount_type
                  - line_item_id
                  example: null
                example: null
              line_item_taxes:
                type: array
                deprecated: false
                description: |
                  The list of taxes applied on line items
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique reference id of the line item for which the tax is applicable
                      maxLength: 40
                      example: null
                    tax_name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax applied
                      maxLength: 100
                      example: null
                    tax_rate:
                      type: number
                      format: double
                      default: 0
                      deprecated: false
                      description: |
                        The rate of tax used to calculate tax amount
                      maximum: 100
                      minimum: 0
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates the service period end of the tax rate for the line item.
                      example: null
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates the service period start of the tax rate for the line item.
                      example: null
                    prorated_taxable_amount:
                      type: number
                      format: decimal
                      deprecated: false
                      description: |
                        Indicates the prorated line item amount in cents.
                      maximum: 1000000000
                      minimum: -1000000000
                      example: null
                    is_partial_tax_applied:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates if tax is applied only on a portion of the line item amount.
                      example: null
                    is_non_compliance_tax:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates the non-compliance tax that should not be reported to the jurisdiction.
                      example: null
                    taxable_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Indicates the actual portion of the line item amount that is taxable.
                      minimum: 0
                      example: null
                    tax_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The tax amount
                      minimum: 0
                      example: null
                    tax_juris_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of tax jurisdiction
                        \* federal -

                        The tax jurisdiction is a federal
                        \* country -

                        The tax jurisdiction is a country
                        \* other -

                        Jurisdictions other than the ones listed above.
                        \* special -

                        Special tax jurisdiction.
                        \* unincorporated -

                        Combined tax of state and county.
                        \* city -

                        The tax jurisdiction is a city
                        \* county -

                        The tax jurisdiction is a county
                        \* state -

                        The tax jurisdiction is a state
                      enum:
                      - country
                      - federal
                      - state
                      - county
                      - city
                      - special
                      - unincorporated
                      - other
                      example: null
                    tax_juris_name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax jurisdiction
                      maxLength: 250
                      example: null
                    tax_juris_code:
                      type: string
                      deprecated: false
                      description: |
                        The tax jurisdiction code
                      maxLength: 250
                      example: null
                    tax_amount_in_local_currency:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                      minimum: 0
                      example: null
                    local_currency_code:
                      type: string
                      deprecated: false
                      description: |
                        The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                      maxLength: 3
                      example: null
                  required:
                  - tax_amount
                  - tax_name
                  - tax_rate
                  - taxable_amount
                  example: null
                example: null
              line_item_credits:
                type: array
                deprecated: false
                description: |
                  A list of store credits applied to line items.
                items:
                  type: object
                  deprecated: false
                  properties:
                    cn_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique ID of the credit note from which the credit is applied.
                      maxLength: 50
                      example: null
                    applied_amount:
                      type: number
                      format: double
                      default: 0
                      deprecated: false
                      description: |
                        The credit amount is applied to the line item.
                      example: null
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique ID of the line item to which this credit is applied.
                      maxLength: 40
                      example: null
                  required:
                  - applied_amount
                  - cn_id
                  example: null
                example: null
              line_item_addresses:
                type: array
                deprecated: false
                description: |
                  The list of addresses used for tax calculation on line items.
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Line item reference
                      maxLength: 40
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer
                      maxLength: 70
                      example: null
                    company:
                      type: string
                      deprecated: false
                      description: |
                        Name of the company
                      maxLength: 250
                      example: null
                    phone:
                      type: string
                      deprecated: false
                      description: |
                        Phone number of the customer
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: |
                        Address line 1
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: |
                        Address line 2
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: |
                        Address line 3
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: |
                        Name of the city
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                        as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                        ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                        ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                        (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                        ).</p>
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        State or Province
                      maxLength: 50
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address of the customer, specified\
                        \ as an [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                        Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ is enabled, 'United Kingdom-Northern Ireland' is a valid\
                        \ option.\n"
                      maxLength: 50
                      example: null
                    zip:
                      type: string
                      deprecated: false
                      description: |
                        Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                        .
                      maxLength: 20
                      example: null
                    validation_status:
                      type: string
                      default: not_validated
                      deprecated: false
                      description: |
                        The address verification status.
                        \* partially_valid -

                        The address is valid for taxability but has not been validated for shipping.
                        \* valid -

                        Address was validated successfully.
                        \* invalid -

                        Address is invalid.
                        \* not_validated -

                        Address is not yet validated.
                      enum:
                      - not_validated
                      - valid
                      - partially_valid
                      - invalid
                      example: null
                  example: null
                example: null
              discounts:
                type: array
                deprecated: false
                description: |
                  The list of discounts applied to this estimate
                items:
                  type: object
                  deprecated: false
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      minimum: 0
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Description for this deduction.
                      maxLength: 250
                      example: null
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      maxLength: 40
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                        * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                        .</p>
                        * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                        applied to the invoice.</p>
                        * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                        * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      enum:
                      - fixed_amount
                      - percentage
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                        , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the coupon.</p>
                      maxLength: 100
                      example: null
                    coupon_set_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                        , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                        is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                      maxLength: 50
                      example: null
                  required:
                  - amount
                  - entity_type
                  example: null
                example: null
              taxes:
                type: array
                deprecated: false
                description: |
                  The list of taxes applied to this estimate
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax applied. E.g. GST.
                      maxLength: 100
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The tax amount.
                      minimum: 0
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Description of the tax item.
                      maxLength: 250
                      example: null
                  required:
                  - amount
                  - name
                  example: null
                example: null
              round_off_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
                  If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
                  , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                  .</p>
                minimum: 0
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this invoice belongs to
                maxLength: 100
                example: null
            required:
            - currency_code
            - price_type
            - recurring
            - sub_total
            example: null
          example: null
        payment_schedule_estimates:
          type: array
          deprecated: false
          description: |
            payment_schedule_estimate resource is used to hold the details related to payment schedules for an invoice. It will contain list of payment_schedules resource.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An auto-generated unique identifier for the payment schedules.
                maxLength: 40
                example: null
              scheme_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The identifier of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_schedule_scheme</code>
                  , used to create the payment schedules.</p>
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this payment schedule is based on
                  \* invoice -

                  invoice
                enum:
                - invoice
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this payment schedule is based on.
                maxLength: 50
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  total maximum amount that this payment schedule is allowed to collect
                minimum: 0
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the transaction amount.
                maxLength: 3
                example: null
              schedule_entries:
                type: array
                deprecated: false
                description: |
                  List of schedule entries
                items:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        An auto-generated unique identifier for the payment schedules.
                      maxLength: 40
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        date at which this payment schedule is scheduled
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        total maximum amount that this payment schedule is allowed to collect
                      minimum: 0
                      example: null
                    status:
                      type: string
                      deprecated: false
                      description: |
                        Defines the status for each payment schedule.
                        \* paid -

                        paid
                        \* posted -

                        posted
                        \* payment_due -

                        payment_due
                      enum:
                      - posted
                      - payment_due
                      - paid
                      example: null
                  required:
                  - amount
                  - date
                  - id
                  - status
                  example: null
                example: null
            required:
            - amount
            - entity_type
            - id
            - scheme_id
            example: null
          example: null
        next_invoice_estimate:
          type: object
          deprecated: false
          description: |
            Represents the preview of the invoice generated at term end when the 'estimate' operations are invoked.
          properties:
            recurring:
              type: boolean
              default: true
              deprecated: false
              description: |
                Whether or not the estimate for the invoice is recurring. Will be 'true' or 'false' for subscription related estimates.
              example: null
            price_type:
              type: string
              default: tax_exclusive
              deprecated: false
              description: |
                The price type of this invoice.
                \* tax_exclusive -

                All amounts in the document are exclusive of tax.
                \* tax_inclusive -

                All amounts in the document are inclusive of tax.
              enum:
              - tax_exclusive
              - tax_inclusive
              example: null
            currency_code:
              type: string
              deprecated: false
              description: |
                The currency code (ISO 4217 format) of the invoice.
              maxLength: 3
              example: null
            sub_total:
              type: integer
              format: int64
              deprecated: false
              description: |
                Invoice sub-total in cents.
              minimum: 0
              example: null
            total:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Invoice total in cents.
              minimum: 0
              example: null
            credits_applied:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                credits applied to this invoice in cents.
              minimum: 0
              example: null
            amount_paid:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Existing outstanding payments if any, applied to this invoice in cents.
              minimum: 0
              example: null
            amount_due:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                Invoice amount due in cents
              minimum: 0
              example: null
            line_items:
              type: array
              deprecated: false
              description: |-
                <p class="mb-2">The details of the line items in this invoice estimate.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><p class="mb-2">Line items that meet <strong class="font-semibold">both</strong> the following conditions are <strong class="font-semibold">not</strong> returned:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">The line item belongs to an item price whose parent item is <code><a href="/docs/api/items/item-object#metered">metered</a></code>.</li>
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item.amount</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>.</li>
                </ul></div>
              items:
                type: object
                deprecated: false
                properties:
                  id:
                    type: string
                    deprecated: false
                    description: |
                      Uniquely identifies a line_item
                    maxLength: 40
                    example: null
                  subscription_id:
                    type: string
                    deprecated: false
                    description: |
                      A unique identifier for the subscription this line item belongs to.
                    maxLength: 50
                    example: null
                  date_from:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Start date of this line item.
                    example: null
                  date_to:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      End date of this line item.
                    example: null
                  unit_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Unit amount of the line item.
                    example: null
                  quantity:
                    type: integer
                    format: int32
                    default: 1
                    deprecated: false
                    description: |
                      [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                      which is represented by this line item.
                    example: null
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total amount of this line item. Typically equals to unit amount x quantity
                    example: null
                  pricing_model:
                    type: string
                    deprecated: false
                    description: |
                      The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                      for this item.
                      \* per_unit -

                      A fixed price per unit quantity.
                      \* tiered -

                      There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                      \* flat_fee -

                      A fixed price that is not quantity-based.
                      \* stairstep -

                      A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                      \* volume -

                      The per unit price is based on the tier that the total quantity falls in.
                    enum:
                    - flat_fee
                    - per_unit
                    - tiered
                    - volume
                    - stairstep
                    example: null
                  is_taxed:
                    type: boolean
                    default: false
                    deprecated: false
                    description: |
                      Specifies whether this line item is taxed or not
                    example: null
                  tax_amount:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |
                      The tax amount charged for this item
                    minimum: 0
                    example: null
                  tax_rate:
                    type: number
                    format: double
                    deprecated: false
                    description: |
                      Rate of tax used to calculate tax for this lineitem
                    maximum: 100
                    minimum: 0
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                      The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 39
                    example: null
                  quantity_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                      x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                      Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 39
                    example: null
                  discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total discounts for this line
                    minimum: 0
                    example: null
                  item_level_discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Line Item-level discounts for this line.
                    minimum: 0
                    example: null
                  metered:
                    type: boolean
                    deprecated: false
                    example: null
                  is_percentage_pricing:
                    type: boolean
                    deprecated: false
                    example: null
                  reference_line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Invoice Reference Line Item ID
                    maxLength: 40
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Detailed description about this line item.
                    maxLength: 250
                    example: null
                  entity_description:
                    type: string
                    deprecated: false
                    description: |
                      Detailed description about this item.
                    maxLength: 500
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |
                      Specifies the modelled entity this line item is based on.
                      \* plan -

                      Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                      id
                      \* plan_item_price -

                      Indicates that this line item is based on plan Item Price
                      \* plan_setup -

                      Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                      id
                      \* addon -

                      Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                      id
                      \* addon_item_price -

                      Indicates that this line item is based on addon Item Price
                      \* adhoc -

                      Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                      \* charge_item_price -

                      Indicates that this line item is based on charge Item Price
                    enum:
                    - plan_setup
                    - plan
                    - addon
                    - adhoc
                    example: null
                  tax_exempt_reason:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                      * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                      * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                      * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                      * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                      * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                      * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                      * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                      and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                      have not been provided for the customer and subscription respectively</p>
                      * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                      * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                      * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                    enum:
                    - tax_not_configured
                    - region_non_taxable
                    - export
                    - customer_exempt
                    - product_exempt
                    - zero_rated
                    - reverse_charge
                    - high_value_physical_goods
                    - zero_value_item
                    - tax_not_configured_external_provider
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                    maxLength: 100
                    example: null
                  customer_id:
                    type: string
                    deprecated: false
                    description: |
                      A unique identifier for the customer this line item belongs to
                    maxLength: 100
                    example: null
                required:
                - date_from
                - date_to
                - description
                - entity_type
                - is_taxed
                - unit_amount
                example: null
              example: null
            line_item_tiers:
              type: array
              deprecated: false
              description: |
                The list of tiers applicable for this line item
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Uniquely identifies a line_item
                    maxLength: 40
                    example: null
                  starting_unit:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The lower limit of a range of units for the tier
                    minimum: 0
                    example: null
                  ending_unit:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The upper limit of a range of units for the tier
                    example: null
                  quantity_used:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The number of units purchased in a range.
                    minimum: 0
                    example: null
                  unit_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |-
                      <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                      pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      pricing.</p>
                    minimum: 0
                    example: null
                  starting_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                      of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                      and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  ending_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                      of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                      or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  quantity_used_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 33
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                      When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                      , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                      The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                      is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                      is enabled.</p>
                    maxLength: 40
                    example: null
                  pricing_type:
                    type: string
                    deprecated: false
                    enum:
                    - per_unit
                    - flat_fee
                    - package
                    example: null
                  package_size:
                    type: integer
                    format: int32
                    deprecated: false
                    minimum: 1
                    example: null
                required:
                - quantity_used
                - starting_unit
                - unit_amount
                example: null
              example: null
            line_item_discounts:
              type: array
              deprecated: false
              description: |
                The list of discount(s) applied for each line item of this invoice.
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique id of the line item that this deduction is for.
                    maxLength: 50
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                      * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                      .</p>
                      * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                      applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case.</p>
                      * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    example: null
                  coupon_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a coupon, then this is the id of the coupon.
                    maxLength: 50
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  discount_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                      .
                    minimum: 0
                    example: null
                required:
                - discount_amount
                - discount_type
                - line_item_id
                example: null
              example: null
            line_item_taxes:
              type: array
              deprecated: false
              description: |
                The list of taxes applied on line items
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique reference id of the line item for which the tax is applicable
                    maxLength: 40
                    example: null
                  tax_name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax applied
                    maxLength: 100
                    example: null
                  tax_rate:
                    type: number
                    format: double
                    default: 0
                    deprecated: false
                    description: |
                      The rate of tax used to calculate tax amount
                    maximum: 100
                    minimum: 0
                    example: null
                  date_to:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Indicates the service period end of the tax rate for the line item.
                    example: null
                  date_from:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Indicates the service period start of the tax rate for the line item.
                    example: null
                  prorated_taxable_amount:
                    type: number
                    format: decimal
                    deprecated: false
                    description: |
                      Indicates the prorated line item amount in cents.
                    maximum: 1000000000
                    minimum: -1000000000
                    example: null
                  is_partial_tax_applied:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates if tax is applied only on a portion of the line item amount.
                    example: null
                  is_non_compliance_tax:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates the non-compliance tax that should not be reported to the jurisdiction.
                    example: null
                  taxable_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Indicates the actual portion of the line item amount that is taxable.
                    minimum: 0
                    example: null
                  tax_amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The tax amount
                    minimum: 0
                    example: null
                  tax_juris_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of tax jurisdiction
                      \* state -

                      The tax jurisdiction is a state
                      \* county -

                      The tax jurisdiction is a county
                      \* special -

                      Special tax jurisdiction.
                      \* country -

                      The tax jurisdiction is a country
                      \* other -

                      Jurisdictions other than the ones listed above.
                      \* city -

                      The tax jurisdiction is a city
                      \* federal -

                      The tax jurisdiction is a federal
                      \* unincorporated -

                      Combined tax of state and county.
                    enum:
                    - country
                    - federal
                    - state
                    - county
                    - city
                    - special
                    - unincorporated
                    - other
                    example: null
                  tax_juris_name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax jurisdiction
                    maxLength: 250
                    example: null
                  tax_juris_code:
                    type: string
                    deprecated: false
                    description: |
                      The tax jurisdiction code
                    maxLength: 250
                    example: null
                  tax_amount_in_local_currency:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                    minimum: 0
                    example: null
                  local_currency_code:
                    type: string
                    deprecated: false
                    description: |
                      The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                    maxLength: 3
                    example: null
                required:
                - tax_amount
                - tax_name
                - tax_rate
                - taxable_amount
                example: null
              example: null
            line_item_credits:
              type: array
              deprecated: false
              description: |
                A list of store credits applied to line items.
              items:
                type: object
                deprecated: false
                properties:
                  cn_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique ID of the credit note from which this credit is applied.
                    maxLength: 50
                    example: null
                  applied_amount:
                    type: number
                    format: double
                    default: 0
                    deprecated: false
                    description: |
                      The credit amount is applied to the line item.
                    example: null
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      The unique ID of the line item to which this credit is applied.
                    maxLength: 40
                    example: null
                required:
                - applied_amount
                - cn_id
                example: null
              example: null
            line_item_addresses:
              type: array
              deprecated: false
              description: |
                The list of addresses used for tax calculation on line items.
              items:
                type: object
                deprecated: false
                properties:
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |
                      Line item reference
                    maxLength: 40
                    example: null
                  first_name:
                    type: string
                    deprecated: false
                    description: |
                      First name of the customer
                    maxLength: 150
                    example: null
                  last_name:
                    type: string
                    deprecated: false
                    description: |
                      Last name of the customer
                    maxLength: 150
                    example: null
                  email:
                    type: string
                    format: email
                    deprecated: false
                    description: |
                      Email of the customer
                    maxLength: 70
                    example: null
                  company:
                    type: string
                    deprecated: false
                    description: |
                      Name of the company
                    maxLength: 250
                    example: null
                  phone:
                    type: string
                    deprecated: false
                    description: |
                      Phone number of the customer
                    maxLength: 50
                    example: null
                  line1:
                    type: string
                    deprecated: false
                    description: |
                      Address line 1
                    maxLength: 150
                    example: null
                  line2:
                    type: string
                    deprecated: false
                    description: |
                      Address line 2
                    maxLength: 150
                    example: null
                  line3:
                    type: string
                    deprecated: false
                    description: |
                      Address line 3
                    maxLength: 150
                    example: null
                  city:
                    type: string
                    deprecated: false
                    description: |
                      Name of the city
                    maxLength: 50
                    example: null
                  state_code:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                      as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                      ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                      ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                      (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                      ).</p>
                    maxLength: 50
                    example: null
                  state:
                    type: string
                    deprecated: false
                    description: |
                      State or Province
                    maxLength: 50
                    example: null
                  country:
                    type: string
                    deprecated: false
                    description: "The billing address of the customer, specified as\
                      \ an [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                      Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                      \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                      \ is enabled, 'United Kingdom-Northern Ireland' is a valid option.\n"
                    maxLength: 50
                    example: null
                  zip:
                    type: string
                    deprecated: false
                    description: |
                      Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                      .
                    maxLength: 20
                    example: null
                  validation_status:
                    type: string
                    default: not_validated
                    deprecated: false
                    description: |
                      The address verification status.
                      \* not_validated -

                      Address is not yet validated.
                      \* partially_valid -

                      The address is valid for taxability but has not been validated for shipping.
                      \* valid -

                      Address was validated successfully.
                      \* invalid -

                      Address is invalid.
                    enum:
                    - not_validated
                    - valid
                    - partially_valid
                    - invalid
                    example: null
                example: null
              example: null
            discounts:
              type: array
              deprecated: false
              description: |
                The list of discounts applied to this estimate
              items:
                type: object
                deprecated: false
                properties:
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                      .
                    minimum: 0
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Description for this deduction.
                    maxLength: 250
                    example: null
                  line_item_id:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                      or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                      .</p>
                    maxLength: 40
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                      * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                      applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                      <span featureId="cb-discounts" isMicro="true"></span>
                      * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                      * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                      applied to the invoice.</p>
                      * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                      in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                      .</p>
                      * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                      The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    enum:
                    - fixed_amount
                    - percentage
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                      , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                      of the coupon.</p>
                    maxLength: 100
                    example: null
                  coupon_set_code:
                    type: string
                    deprecated: false
                    description: |-
                      <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                      , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                      is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                      .</p>
                    maxLength: 50
                    example: null
                required:
                - amount
                - entity_type
                example: null
              example: null
            taxes:
              type: array
              deprecated: false
              description: |
                The list of taxes applied to this estimate
              items:
                type: object
                deprecated: false
                properties:
                  name:
                    type: string
                    deprecated: false
                    description: |
                      The name of the tax applied. E.g. GST.
                    maxLength: 100
                    example: null
                  amount:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The tax amount.
                    minimum: 0
                    example: null
                  description:
                    type: string
                    deprecated: false
                    description: |
                      Description of the tax item.
                    maxLength: 250
                    example: null
                required:
                - amount
                - name
                example: null
              example: null
            round_off_amount:
              type: integer
              format: int64
              deprecated: false
              description: |-
                <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
                If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
                , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                .</p>
              minimum: 0
              example: null
            customer_id:
              type: string
              deprecated: false
              description: |
                A unique identifier for the customer this invoice belongs to
              maxLength: 100
              example: null
          required:
          - currency_code
          - price_type
          - recurring
          - sub_total
          example: null
        credit_note_estimates:
          type: array
          deprecated: false
          description: |
            Represents the preview of the credit-notes generated during 'estimate' operation. Currently applicable only for the 'Update Subscription Estimate' operation.
          items:
            type: object
            deprecated: false
            properties:
              reference_invoice_id:
                type: string
                deprecated: false
                description: |
                  The reference invoice id
                maxLength: 50
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  Credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)
                  about credit note types.
                  \* refundable -

                  Refundable Credit Note
                  \* adjustment -

                  Adjustment Credit Note
                  \* store -

                  Store Credit Note
                enum:
                - adjustment
                - refundable
                - store
                example: null
              price_type:
                type: string
                default: tax_exclusive
                deprecated: false
                description: |
                  The price type of this credit note.
                  \* tax_inclusive -

                  All amounts in the document are inclusive of tax.
                  \* tax_exclusive -

                  All amounts in the document are exclusive of tax.
                enum:
                - tax_exclusive
                - tax_inclusive
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the credit note.
                maxLength: 3
                example: null
              sub_total:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Invoice sub-total in cents.
                minimum: 0
                example: null
              total:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Credit note total in cents.
                minimum: 0
                example: null
              amount_allocated:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Allocated credits in cents.
                minimum: 0
                example: null
              amount_available:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Remaining credits in cents
                minimum: 0
                example: null
              line_items:
                type: array
                deprecated: false
                description: |
                  The list of items in this estimate
                items:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a line_item
                      maxLength: 40
                      example: null
                    subscription_id:
                      type: string
                      deprecated: false
                      description: |
                        A unique identifier for the subscription this line item belongs to.
                      maxLength: 50
                      example: null
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Start date of this line item.
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End date of this line item.
                      example: null
                    unit_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Unit amount of the line item.
                      example: null
                    quantity:
                      type: integer
                      format: int32
                      default: 1
                      deprecated: false
                      description: |
                        [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                        which is represented by this line item.
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total amount of this line item. Typically equals to unit amount x quantity
                      example: null
                    pricing_model:
                      type: string
                      deprecated: false
                      description: |
                        The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                        for this item.
                        \* volume -

                        The per unit price is based on the tier that the total quantity falls in.
                        \* per_unit -

                        A fixed price per unit quantity.
                        \* tiered -

                        There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                        \* stairstep -

                        A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                        \* flat_fee -

                        A fixed price that is not quantity-based.
                      enum:
                      - flat_fee
                      - per_unit
                      - tiered
                      - volume
                      - stairstep
                      example: null
                    is_taxed:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Specifies whether this line item is taxed or not
                      example: null
                    tax_amount:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |
                        The tax amount charged for this item
                      minimum: 0
                      example: null
                    tax_rate:
                      type: number
                      format: double
                      deprecated: false
                      description: |
                        Rate of tax used to calculate tax for this lineitem
                      maximum: 100
                      minimum: 0
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 39
                      example: null
                    quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                        x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                        Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 39
                      example: null
                    discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total discounts for this line
                      minimum: 0
                      example: null
                    item_level_discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Line Item-level discounts for this line.
                      minimum: 0
                      example: null
                    metered:
                      type: boolean
                      deprecated: false
                      example: null
                    is_percentage_pricing:
                      type: boolean
                      deprecated: false
                      example: null
                    reference_line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Invoice Reference Line Item ID
                      maxLength: 40
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Detailed description about this line item.
                      maxLength: 250
                      example: null
                    entity_description:
                      type: string
                      deprecated: false
                      description: |
                        Detailed description about this item.
                      maxLength: 500
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |
                        Specifies the modelled entity this line item is based on.
                        \* addon -

                        Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                        id
                        \* addon_item_price -

                        Indicates that this line item is based on addon Item Price
                        \* charge_item_price -

                        Indicates that this line item is based on charge Item Price
                        \* adhoc -

                        Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                        \* plan_setup -

                        Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                        id
                        \* plan_item_price -

                        Indicates that this line item is based on plan Item Price
                        \* plan -

                        Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                        id
                      enum:
                      - plan_setup
                      - plan
                      - addon
                      - adhoc
                      example: null
                    tax_exempt_reason:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                        * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                        and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                        have not been provided for the customer and subscription respectively</p>
                        * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                        * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                        * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                        * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                        * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                        * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                        * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                        * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                        * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                      enum:
                      - tax_not_configured
                      - region_non_taxable
                      - export
                      - customer_exempt
                      - product_exempt
                      - zero_rated
                      - reverse_charge
                      - high_value_physical_goods
                      - zero_value_item
                      - tax_not_configured_external_provider
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                      maxLength: 100
                      example: null
                    customer_id:
                      type: string
                      deprecated: false
                      description: |
                        A unique identifier for the customer this line item belongs to
                      maxLength: 100
                      example: null
                  required:
                  - date_from
                  - date_to
                  - description
                  - entity_type
                  - is_taxed
                  - unit_amount
                  example: null
                example: null
              line_item_tiers:
                type: array
                deprecated: false
                description: |
                  The list of tiers applicable for this line item
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a line_item
                      maxLength: 40
                      example: null
                    starting_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The lower limit of a range of units for the tier
                      minimum: 0
                      example: null
                    ending_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The upper limit of a range of units for the tier
                      example: null
                    quantity_used:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of units purchased in a range.
                      minimum: 0
                      example: null
                    unit_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      minimum: 1
                      example: null
                  required:
                  - quantity_used
                  - starting_unit
                  - unit_amount
                  example: null
                example: null
              line_item_discounts:
                type: array
                deprecated: false
                description: |
                  The list of discount(s) applied for each line item of this invoice.
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique id of the line item that this deduction is for.
                      maxLength: 50
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                        * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                        * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                        .</p>
                        * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                        applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case.</p>
                        * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      example: null
                    coupon_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a coupon, then this is the id of the coupon.
                      maxLength: 50
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    discount_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      minimum: 0
                      example: null
                  required:
                  - discount_amount
                  - discount_type
                  - line_item_id
                  example: null
                example: null
              line_item_taxes:
                type: array
                deprecated: false
                description: |
                  The list of taxes applied on line items
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        The unique reference id of the line item for which the tax is applicable
                      maxLength: 40
                      example: null
                    tax_name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax applied
                      maxLength: 100
                      example: null
                    tax_rate:
                      type: number
                      format: double
                      default: 0
                      deprecated: false
                      description: |
                        The rate of tax used to calculate tax amount
                      maximum: 100
                      minimum: 0
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates the service period end of the tax rate for the line item.
                      example: null
                    date_from:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Indicates the service period start of the tax rate for the line item.
                      example: null
                    prorated_taxable_amount:
                      type: number
                      format: decimal
                      deprecated: false
                      description: |
                        Indicates the prorated line item amount in cents.
                      maximum: 1000000000
                      minimum: -1000000000
                      example: null
                    is_partial_tax_applied:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates if tax is applied only on a portion of the line item amount.
                      example: null
                    is_non_compliance_tax:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates the non-compliance tax that should not be reported to the jurisdiction.
                      example: null
                    taxable_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Indicates the actual portion of the line item amount that is taxable.
                      minimum: 0
                      example: null
                    tax_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The tax amount
                      minimum: 0
                      example: null
                    tax_juris_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of tax jurisdiction
                        \* county -

                        The tax jurisdiction is a county
                        \* unincorporated -

                        Combined tax of state and county.
                        \* city -

                        The tax jurisdiction is a city
                        \* state -

                        The tax jurisdiction is a state
                        \* country -

                        The tax jurisdiction is a country
                        \* federal -

                        The tax jurisdiction is a federal
                        \* other -

                        Jurisdictions other than the ones listed above.
                        \* special -

                        Special tax jurisdiction.
                      enum:
                      - country
                      - federal
                      - state
                      - county
                      - city
                      - special
                      - unincorporated
                      - other
                      example: null
                    tax_juris_name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax jurisdiction
                      maxLength: 250
                      example: null
                    tax_juris_code:
                      type: string
                      deprecated: false
                      description: |
                        The tax jurisdiction code
                      maxLength: 250
                      example: null
                    tax_amount_in_local_currency:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                      minimum: 0
                      example: null
                    local_currency_code:
                      type: string
                      deprecated: false
                      description: |
                        The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                      maxLength: 3
                      example: null
                  required:
                  - tax_amount
                  - tax_name
                  - tax_rate
                  - taxable_amount
                  example: null
                example: null
              discounts:
                type: array
                deprecated: false
                description: |
                  The list of discounts applied to this estimate
                items:
                  type: object
                  deprecated: false
                  properties:
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                        .
                      minimum: 0
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Description for this deduction.
                      maxLength: 250
                      example: null
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                        .</p>
                      maxLength: 40
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                        * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                        The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                        * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                        applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                        <span featureId="cb-discounts" isMicro="true"></span>
                        * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                        applied to the invoice.</p>
                        * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                        in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                        .</p>
                        * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      enum:
                      - fixed_amount
                      - percentage
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                        , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                        of the coupon.</p>
                      maxLength: 100
                      example: null
                    coupon_set_code:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                        , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                        is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                        .</p>
                      maxLength: 50
                      example: null
                  required:
                  - amount
                  - entity_type
                  example: null
                example: null
              taxes:
                type: array
                deprecated: false
                description: |
                  The list of taxes applied to this estimate
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      description: |
                        The name of the tax applied. E.g. GST.
                      maxLength: 100
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The tax amount.
                      minimum: 0
                      example: null
                    description:
                      type: string
                      deprecated: false
                      description: |
                        Description of the tax item.
                      maxLength: 250
                      example: null
                  required:
                  - amount
                  - name
                  example: null
                example: null
              round_off_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
                  If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
                  , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
                  .</p>
                minimum: 0
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this credit note belongs to
                maxLength: 100
                example: null
            required:
            - amount_allocated
            - amount_available
            - currency_code
            - price_type
            - reference_invoice_id
            - sub_total
            - total
            - type
            example: null
          example: null
        unbilled_charge_estimates:
          type: array
          deprecated: false
          description: |
            Represents the preview of the unbilled charges generated during 'estimate' operation. Currently not applicable for the 'Subscription renewal estimate' operation.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies an unbilled charge.
                maxLength: 40
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer being charged.
                maxLength: 50
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the subscription this charge belongs to.
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of this charge.
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of this charge.
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Unit amount of the charge item.
                minimum: 0
                example: null
              pricing_model:
                type: string
                deprecated: false
                description: |
                  The pricing scheme for this line item.
                  \* stairstep -

                  A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  \* volume -

                  The per unit price is based on the tier that the total quantity falls in.
                  \* per_unit -

                  A fixed price per unit quantity.
                  \* flat_fee -

                  A fixed price that is not quantity-based.
                  \* tiered -

                  There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Quantity of the item which is represented by this charge.
                minimum: 0
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of this charge. Typically equals to unit amount x quantity.
                minimum: 0
                example: null
              currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) for the charge.
                maxLength: 3
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total discounts for this charge.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this charge.
                maxLength: 250
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this line item is based on.
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
                maxLength: 100
                example: null
              is_voided:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
                example: null
              voided_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating the date and time this charge got voided.
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the amount for the charge, in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                  x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                  Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 39
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when the unbilled charge was last updated
                example: null
              tiers:
                type: array
                deprecated: false
                description: |
                  The list of tiers applicable for this line item
                items:
                  type: object
                  deprecated: false
                  properties:
                    line_item_id:
                      type: string
                      deprecated: false
                      description: |
                        Uniquely identifies a line_item
                      maxLength: 40
                      example: null
                    starting_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The lower limit of a range of units for the tier
                      minimum: 0
                      example: null
                    ending_unit:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The upper limit of a range of units for the tier
                      example: null
                    quantity_used:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of units purchased in a range.
                      minimum: 0
                      example: null
                    unit_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |-
                        <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                        pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        pricing.</p>
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                        of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                        of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                        or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |-
                        <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                        or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                        When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                        is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                        , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                        The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                        is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                        is enabled.</p>
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      minimum: 1
                      example: null
                  required:
                  - quantity_used
                  - starting_unit
                  - unit_amount
                  example: null
                example: null
              is_advance_charge:
                type: boolean
                default: false
                deprecated: false
                description: |
                  The value of this parameter will be true if it is a recurring unbilled charge for a future term.
                example: null
              business_entity_id:
                type: string
                deprecated: false
                description: "The ID of the business entity created for the site.\
                  \ For Product Catalog 1.0, all the site data is tied to this business\
                  \ entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started)\
                  \ is a feature available only on Product Catalog 2.0.\n"
                maxLength: 50
                example: null
              deleted:
                type: boolean
                deprecated: false
                description: |
                  Indicates that this resource has been deleted.
                example: null
            required:
            - currency_code
            - deleted
            - entity_type
            - is_voided
            - updated_at
            example: null
          example: null
      required:
      - created_at
      example: null
    Event:
      type: object
      description: |-
        <div class="api-description"><h3>Introduction</h3><p class="mb-2">Whenever any important changes happen in your Chargebee site, they are recorded as events. An event contains data about affected resources and additional details such as when the change occurred. For example, when a subscription is cancelled due to non payment, an event <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_cancelled</code> is recorded.</p><h3>Webhooks</h3><p class="mb-2">If webhooks have been <a href="https://www.chargebee.com/docs/webhook_settings.html#configure-webhooks" target="_blank">configured</a> in Chargebee, events trigger those webhooks. If multiple webhooks have been configured, for every event, each webhook is called one after another. If a webhook call for an event fails or times out, it is retried based on a <a href="https://www.chargebee.com/docs/webhook_settings.html#automatic-retries" target="_blank">fixed schedule</a>. The webhook call is an HTTP POST with content type <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">application/json</code>.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Caution:</strong>
        Webhooks are asynchronous and are not recommended for time-critical applications. It is very much possible and even likely that webhooks reach your application out-of-order and that they get duplicated. For time-critical applications, we recommend using the <a href="/docs/api/events/list-events">List events API</a> to poll Chargebee for events.</p></div><h4>Retries &amp; Duplicate Handling</h4><p class="mb-2">To mark a webhook notification successful, we expect the <a href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes" target="_blank">HTTP status code</a> to be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">2XX</code> from your webhook URL. If we don&#x27;t receive <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">2XX</code> response code, we <a href="https://www.chargebee.com/docs/webhook_settings.html#automatic-retries" target="_blank">retry</a> calling your webhook with a progressively increasing delay for the next 2 days. You could also <a href="https://www.chargebee.com/docs/webhook_settings.html#automatic-retries" target="_blank">resend</a> webhooks manually from the web console.
        Due to webhook retries, it&#x27;s possible that your application receives the same webhook more than once. Ensure idempotency of the webhook call by detecting such duplicates within your application. This can be done by examining the <a href="/docs/api/events/event-object#id">id</a> parameter since its value uniquely identifies an event.
        For example, your application could do the following for each webhook notification:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Get the event <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> and keep it in a persistent store such as a relational database or redis.</li>
        <li class="text-base leading-relaxed">Check whether the event <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> is already processed.</li>
        <li class="text-base leading-relaxed">If the event has not been processed then process the event; otherwise, it is a duplicate event so can be ignored.</li>
        <li class="text-base leading-relaxed">Also, since the last retry for a webhook happens at around 3 days and 7 hours after the original event trigger, keep the idempotency window as 3 days and 7 hours. In other words, you may purge the stored event ids that are more than 3 days and 7 hours old.</li>
        </ol><h4>Out-of-order Delivery</h4><p class="mb-2">Webhooks can also arrive at your application out-of-order. This can be due to issues such as network delays or webhook failures. However, you can order the events by examining the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> attribute of the resource sent by the webhook. For every change made to the resource, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> is updated with a new timestamp in milliseconds.
        For example, if you wish to sync resource changes from Chargebee to your application, you could:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Get the value (rv1) of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> attribute from the resource in the webhook.</li>
        <li class="text-base leading-relaxed">Get the value (rv2) of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> from the resource stored on your side.</li>
        <li class="text-base leading-relaxed">If rv1 &gt; rv2, process the resource; otherwise, ignore.</li>
        </ol><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">API Version</strong>
        Chargebee supports multiple API versions now. The <a href="/docs/api/events/event-object#api_version"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">api_version</code></a> attribute indicates the API version based on which the event content is structured. While processing webhooks, ensure that <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">api_version</code> is same as the API version used by your webhook server&#x27;s client library.</p></div><h4>Securing Your Webhook URL</h4><p class="mb-2">You can have <strong class="font-semibold">basic authentication</strong>
        for the webhook url.</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">In the Webhook Settings page (<strong class="font-semibold">Settings &gt; Configure Chargebee &gt; Webhooks</strong>),choose the tab for the webhook and check the option <strong class="font-semibold">My webhook URL is protected by basic authentication.</strong></li>
        <li class="text-base leading-relaxed">Enter <strong class="font-semibold">Username</strong> and <strong class="font-semibold">Password</strong> and click <strong class="font-semibold">Update Webhook.</strong>
        OR
        Generate a random key and have it as part of your webhook URL
        eg. http://yourapp.com/chargebee-webhook/cuktqaem0i2fkd5jt9cdtojcn9cvb3Y</li>
        </ol><p class="mb-2">In addition to securing your webhook, you can ensure the integrity of the event data by fetching it again using the <a href="/docs/api/events/retrieve-an-event">Retrieve an Event</a>
        API call.</p><h4>Webhook IP Addresses</h4><p class="mb-2">Webhooks from Chargebee originate from a <a href="/docs/api/v2/pcv-1/webhooks">specific set of IP addresses</a>.</p></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies a event
          maxLength: 40
          example: null
        occurred_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this event had occurred.
          example: null
        source:
          type: string
          default: none
          deprecated: false
          description: |
            Source of the event
            \* admin_console -

            Operation made through the Chargebee admin UI
            \* external_service -

            Operation that are triggered via webhook
            \* scheduled_job -

            Operation made through the Scheduled Jobs
            \* bulk_operation -

            Operation that are triggerd through bulk operation.
            \* hosted_page -

            Operation made through the Hosted Pages
            \* portal -

            Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)
            \* system -

            Operation that are triggered by ChargeBee System
            \* migration -

            Deprecated
            \* none -

            If no source can be identified for an operation
            \* api -

            Operation made through the API
            \* js_api -

            Operation made through the JS API
          enum:
          - admin_console
          - api
          - scheduled_job
          - hosted_page
          - portal
          - system
          - none
          - js_api
          - migration
          - bulk_operation
          - external_service
          example: null
        user:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The &quot;user&quot;&quot; that triggered the event. The value depends on the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">source</code></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">source</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">admin_console</code>: the email address of the user that triggered the event.</li>
            <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">source</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">api</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">js_api</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bulk_operation</code>: the <a href="https://www.chargebee.com/docs/api_keys.html#create-an-api-key" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">name</a> of the API key that was used to trigger the event.</li>
            <li class="text-base leading-relaxed">When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">source</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">external_service</code>: the name of the service that called our webhook. Eg. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ADYEN</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">STRIPE</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AMAZON_PAYMENTS</code> etc.</li>
            <li class="text-base leading-relaxed">When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">source</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">portal</code>: the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">user</code> attribute is not passed.</li>
            </ul>
          maxLength: 150
          example: null
        event_type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The types of event provided by chargebee. Refer <a href="/docs/api/v2/pcv-1/events/event-types">event types</a>
            for all the event types provided by us currently.</p>
            * card_deleted - <p class="mb-2">Sent when a card is deleted for a customer</p>
            * subscription_cancelled - <p class="mb-2">Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;.</p>
            * customer_changed - <p class="mb-2">Sent when a customer is changed</p>
            * invoice_deleted - <p class="mb-2">Event triggered when an invoice is deleted.</p>
            * subscription_shipping_address_updated - <p class="mb-2">Triggered when shipping address is added or updated for a subscription.</p>
            * differential_price_created - <p class="mb-2">Triggered when a differential price is created</p>
            * subscription_created - <p class="mb-2">Sent when a new subscription is created.</p>
            * payment_initiated - <p class="mb-2">Sent when a payment is initiated via direct debit</p>
            * quote_updated - <p class="mb-2">Triggered when quote is updated</p>
            * payment_source_added - <p class="mb-2">Sent when a payment source is added for a customer.</p>
            * contract_term_created - <p class="mb-2">Triggered when new contract term is created</p>
            * subscription_business_entity_changed - <p class="mb-2">Sent when a subscription&#x27;s business entity is changed.</p>
            * subscription_deleted - <p class="mb-2">Sent when a subscription has been deleted</p>
            * differential_price_deleted - <p class="mb-2">Triggered when a differential price is deleted</p>
            * voucher_created - <p class="mb-2">Triggered when a payment voucher is created</p>
            * transaction_deleted - <p class="mb-2">Triggered when a transaction is deleted.</p>
            * item_family_deleted - <p class="mb-2">Triggered when an item family is deleted</p>
            * product_updated - <p class="mb-2">Triggered when the product update is completed successfully</p>
            * payment_failed - <p class="mb-2">Sent when attempt to charge customer&#x27;s credit card fails</p>
            * subscription_reactivated_with_backdating - <p class="mb-2">Sent when the subscription is moved from cancelled state to active or in_trial state with past date</p>
            * payment_source_expiring - <p class="mb-2">Sent when the customer&#x27;s payment source is expiring soon. Sent 30 days before the expiry date.</p>
            * subscription_entitlements_updated - <p class="mb-2">Triggered when subscription entitlements are updated for a subscription change.</p>
            * item_price_updated - <p class="mb-2">Triggered when an item price is updated</p>
            * order_ready_to_process - <p class="mb-2">Triggered when order reaches it&#x27;s order date</p>
            * entitlement_overrides_updated - <p class="mb-2">Triggered when an override entitlement is updated</p>
            * item_updated - <p class="mb-2">Triggered when an item is updated</p>
            * coupon_set_updated - <p class="mb-2">Sent when a coupon set is changed</p>
            * subscription_reactivated - <p class="mb-2">Sent when the subscription is moved from cancelled state to active or in_trial state</p>
            * variant_created - <p class="mb-2">Triggered when product variant create completed successfully</p>
            * addon_updated - <p class="mb-2">Sent when a addon is changed.</p>
            * subscription_scheduled_changes_removed - <p class="mb-2">Sent when scheduled change for the subscription is removed.</p>
            * customer_business_entity_changed - <p class="mb-2">Sent when a customer&#x27;s business entity is changed.</p>
            * payment_refunded - <p class="mb-2">Sent when a payment refund is made</p>
            * subscription_started - <p class="mb-2">Sent when a &#x27;future&#x27; subscription gets started at the scheduled date.</p>
            * attached_item_created - <p class="mb-2">Triggered when an Attached item is created</p>
            * token_created - <p class="mb-2">Sent when a Token is created</p>
            * item_family_created - <p class="mb-2">Triggered when an item family is created</p>
            * subscription_created_with_backdating - <p class="mb-2">Sent when a new subscription is created with backdating.</p>
            * unbilled_charges_deleted - <p class="mb-2">Triggered when unbilled charges are deleted</p>
            * promotional_credits_added - <p class="mb-2">Sent when a customer prmotion credits added</p>
            * subscription_canceled_with_backdating - <p class="mb-2">Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;.</p>
            * item_entitlements_updated - <p class="mb-2">Triggered when item entitlements are updated to a feature</p>
            * card_expired - <p class="mb-2">Sent when a card for a customer is expired</p>
            * payment_intent_created - <p class="mb-2">Sent when a Payment intent is created</p>
            * subscription_changed_with_backdating - <p class="mb-2">Sent after the subscription&#x27;s recurring items have been changed with backdated date</p>
            * subscription_scheduled_cancellation_removed - <p class="mb-2">Sent when scheduled cancellation is removed for the subscription.</p>
            * feature_updated - <p class="mb-2">Triggered when an feature is updated</p>
            * plan_deleted - <p class="mb-2">Sent when a plan is deleted.</p>
            * tax_withheld_refunded - <p class="mb-2">Sent when a tax withheld refund is made</p>
            * unbilled_charges_voided - <p class="mb-2">Triggered when unbilled charges are voided</p>
            * customer_moved_out - <p class="mb-2">Sent when a customer is copied to another site</p>
            * feature_created - <p class="mb-2">Triggered when a feature is created.</p>
            * coupon_codes_deleted - <p class="mb-2">Sent when coupon codes are deleted in coupon set</p>
            * subscription_paused - <p class="mb-2">Sent when the subscription is paused.</p>
            * order_updated - <p class="mb-2">Triggered when order is updated</p>
            * unbilled_charges_created - <p class="mb-2">Triggered when unbilled charges are created</p>
            * feature_archived - <p class="mb-2">Triggered when an feature is archived</p>
            * payment_succeeded - <p class="mb-2">Sent when the payment is successfully collected</p>
            * voucher_expired - <p class="mb-2">Triggered when a payment voucher is expired</p>
            * mrr_updated - <p class="mb-2">Sent when either of MRR or CMRR of a subscription changes</p>
            * subscription_scheduled_resumption_removed - <p class="mb-2">Triggered when scheduled resumption is removed for the subscription.</p>
            * subscription_changes_scheduled - <p class="mb-2">Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term.</p>
            * order_ready_to_ship - <p class="mb-2">Triggered when order reaches it&#x27;s shipping date</p>
            * purchase_created - <p class="mb-2">Triggered when purchase action completed successfully</p>
            * variant_updated - <p class="mb-2">Triggered when product variant update completed successfully</p>
            * variant_deleted - <p class="mb-2">Triggered when product variant delete completed successfully</p>
            * subscription_trial_end_reminder - <p class="mb-2">Sent when the customer&#x27;s trial period is about to end.</p>
            * feature_activated - <p class="mb-2">Triggered when a feature <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> transitions to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> for the first time.</p>
            * subscription_renewed - <p class="mb-2">Sent when the subscription is renewed from the current term.</p>
            * plan_created - <p class="mb-2">Sent when a plan is created.</p>
            * item_created - <p class="mb-2">Triggered when an item is created</p>
            * coupon_codes_updated - <p class="mb-2">Sent when coupon codes are updated</p>
            * gift_unclaimed - <p class="mb-2">Triggered when a new gift is unclaimed and is ready to be claimed</p>
            * subscription_entitlements_created - <p class="mb-2">Triggered when subscription entitlements are created for a new subscription</p>
            * virtual_bank_account_added - <p class="mb-2">Sent when a virtual bank account is added for a customer.</p>
            * contract_term_completed - <p class="mb-2">Triggered when contract term is completed</p>
            * feature_deleted - <p class="mb-2">Triggered when a feature is deleted</p>
            * subscription_renewal_reminder - <p class="mb-2">Sent before each subscription&#x27;s renewal based on plan&#x27;s period</p>
            * coupon_updated - <p class="mb-2">Sent when a coupon is changed.</p>
            * token_consumed - <p class="mb-2">Sent when a Token is consumed</p>
            * transaction_created - <p class="mb-2">Triggered when a transaction is recorded</p>
            * customer_deleted - <p class="mb-2">Sent when a customer is deleted</p>
            * coupon_deleted - <p class="mb-2">Sent when a coupon is deleted.</p>
            * quote_deleted - <p class="mb-2">Triggered when quote is deleted</p>
            * card_updated - <p class="mb-2">Sent when the card is updated for a customer.</p>
            * coupon_created - <p class="mb-2">Sent when a coupon is created.</p>
            * quote_created - <p class="mb-2">Triggered when quote is created</p>
            * add_usages_reminder - <p class="mb-2">Sent every month day before renewal date of plan&#x27;s period</p>
            * business_entity_updated - <p class="mb-2">Sent when a business entity is updated.</p>
            * subscription_changed - <p class="mb-2">Sent after the subscription&#x27;s recurring items have been changed</p>
            * customer_created - <p class="mb-2">Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation.</p>
            * coupon_set_deleted - <p class="mb-2">Sent when a coupon set is deleted</p>
            * refund_initiated - <p class="mb-2">Sent when a refund is initiated via direct debit</p>
            * order_cancelled - <p class="mb-2">Triggered when order is cancelled</p>
            * entitlement_overrides_removed - <p class="mb-2">Triggered when an override entitlement is removed</p>
            * coupon_codes_added - <p class="mb-2">Sent when coupon codes are added in coupon set</p>
            * card_added - <p class="mb-2">Sent when a card is added for a customer.</p>
            * gift_cancelled - <p class="mb-2">Triggered when a gift is cancelled.</p>
            * entitlement_overrides_auto_removed - <p class="mb-2">Triggered when Subscription entitlements overrides for a feature are auto removed after expiry</p>
            * payment_source_deleted - <p class="mb-2">Sent when a payment source is deleted for a customer</p>
            * credit_note_created - <p class="mb-2">Sent when a credit note is created</p>
            * subscription_resumption_scheduled - <p class="mb-2">Triggered when the subscription resumption is scheduled.</p>
            * item_price_deleted - <p class="mb-2">Triggered when an item price is deleted</p>
            * subscription_advance_invoice_schedule_updated - <p class="mb-2">Triggered when scheduled advance invoice is updated for a subscription.</p>
            * item_deleted - <p class="mb-2">Triggered when an item is deleted</p>
            * gift_claimed - <p class="mb-2">Triggered when a gift is claimed</p>
            * feature_reactivated - <p class="mb-2">Triggered when a feature <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> transitions to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> for the second time or more.</p>
            * subscription_activated - <p class="mb-2">Sent after the subscription has been moved from trial to active state</p>
            * subscription_resumed - <p class="mb-2">Sent when the subscription is moved from paused state to active state</p>
            * credit_note_deleted - <p class="mb-2">Sent when a credit note is deleted</p>
            * item_price_entitlements_removed - <p class="mb-2">Triggered when item price entitlements are removed for a feature</p>
            * subscription_advance_invoice_schedule_added - <p class="mb-2">Triggered when advance invoice is scheduled for a subscription.</p>
            * differential_price_updated - <p class="mb-2">Triggered when a differential price is updated</p>
            * order_deleted - <p class="mb-2">Triggered when order is deleted</p>
            * token_expired - <p class="mb-2">Sent when a Token is expired</p>
            * transaction_updated - <p class="mb-2">Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.</p>
            * subscription_cancellation_reminder - <p class="mb-2">Sent when the customer&#x27;s subscription is nearing it&#x27;s scheduled cancellation date.</p>
            * product_deleted - <p class="mb-2">Triggered when the product delete is completed successfully</p>
            * invoice_generated - <p class="mb-2">Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a &quot;Pending&quot; invoice is closed.</p>
            * order_delivered - <p class="mb-2">Triggered when order is marked as delivered</p>
            * pending_invoice_created - <p class="mb-2">Event triggered (in the case of metered billing) when a &quot;Pending&quot; invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the &quot;Notify for Pending Invoices&quot; option is enabled.</p>
            * authorization_succeeded - <p class="mb-2">Triggered when a authorization transaction is created.</p>
            * invoice_generated_with_backdating - <p class="mb-2">Event triggered when a new invoice is generated with past date as invoice date.</p>
            * subscription_cancellation_scheduled - <p class="mb-2">Sent when subscription is scheduled to cancel at end of current term</p>
            * order_created - <p class="mb-2">Triggered when order is created</p>
            * hierarchy_deleted - <p class="mb-2">Triggered when a hierarchy is deleted</p>
            * subscription_activated_with_backdating - <p class="mb-2">Sent after the subscription changes to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> from another <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, while the change is backdated.</p>
            * plan_updated - <p class="mb-2">Sent when a plan is changed.</p>
            * tax_withheld_recorded - <p class="mb-2">Triggered when a tax withheld is recorded for an invoice</p>
            * credit_note_created_with_backdating - <p class="mb-2">Sent when a credit note is created with past date as credit note date</p>
            * gift_updated - <p class="mb-2">Triggered when a gift is updated</p>
            * order_resent - <p class="mb-2">Triggered when order is resent</p>
            * hierarchy_created - <p class="mb-2">Triggered when a hierarchy is created</p>
            * addon_deleted - <p class="mb-2">Sent when a addon is deleted.</p>
            * voucher_create_failed - <p class="mb-2">Triggered when a payment voucher creation is failed</p>
            * customer_moved_in - <p class="mb-2">Sent when a customer is copied from another site</p>
            * item_price_entitlements_updated - <p class="mb-2">Triggered when item Price entitlements are updated to a feature</p>
            * attached_item_deleted - <p class="mb-2">Triggered when an Attached item is deleted</p>
            * unbilled_charges_invoiced - <p class="mb-2">Triggered when unbilled charges are invoiced</p>
            * subscription_pause_scheduled - <p class="mb-2">Sent when the subscription is scheduled to pause.</p>
            * order_returned - <p class="mb-2">Triggered when order is marked as returned</p>
            * payment_source_expired - <p class="mb-2">Sent when a payment source for a customer is expired</p>
            * contract_term_terminated - <p class="mb-2">Triggered when contract term is terminated</p>
            * product_created - <p class="mb-2">Triggered when the product create is completed successfully</p>
            * payment_source_updated - <p class="mb-2">Sent when the payment source is updated for a customer or when role is assigned to the payment source.</p>
            * pending_invoice_updated - <p class="mb-2">Event triggered when the option &quot;Notify and wait to close invoices&quot; is enabled, and the &#x27;Pending&#x27; invoice is updated.</p>
            * subscription_advance_invoice_schedule_removed - <p class="mb-2">Triggered when scheduled advance invoice is removed for a subscription.</p>
            * tax_withheld_deleted - <p class="mb-2">Triggered when a tax withheld is deleted</p>
            * business_entity_created - <p class="mb-2">Sent when a business entity is created.</p>
            * item_price_created - <p class="mb-2">Triggered when an item price is created</p>
            * virtual_bank_account_updated - <p class="mb-2">Sent when the virtual bank account is updated for a customer.</p>
            * credit_note_updated - <p class="mb-2">Sent when a credit note is updated</p>
            * subscription_scheduled_pause_removed - <p class="mb-2">Triggered when scheduled pause is removed for the subscription.</p>
            * card_expiry_reminder - <p class="mb-2">Sent when the customer&#x27;s credit card is expiring soon. Sent 30 days before the expiry date.</p>
            * coupon_set_created - <p class="mb-2">Sent when a coupon set is created</p>
            * virtual_bank_account_deleted - <p class="mb-2">Sent when a virtual bank account is deleted for a customer.</p>
            * gift_scheduled - <p class="mb-2">Triggered when a new gift is created</p>
            * business_entity_deleted - <p class="mb-2">Sent when a business entity is deleted.</p>
            * promotional_credits_deducted - <p class="mb-2">Sent when a customer prmotion credits deducted</p>
            * contract_term_renewed - <p class="mb-2">Triggered when new contract term is renewed</p>
            * subscription_trial_extended - <p class="mb-2">Trial Extension</p>
            * item_entitlements_removed - <p class="mb-2">Triggered when item entitlements are removed for a feature</p>
            * gift_expired - <p class="mb-2">Triggered when a gift expires</p>
            * contract_term_cancelled - <p class="mb-2">Triggered when contract term is cancelled</p>
            * authorization_voided - <p class="mb-2">Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.</p>
            * item_family_updated - <p class="mb-2">Triggered when an item family is updated</p>
            * addon_created - <p class="mb-2">Sent when a addon is created.</p>
            * attached_item_updated - <p class="mb-2">Triggered when an Attached item is updated</p>
            * invoice_updated - <p class="mb-2">Triggered when the invoice&#x27;s shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed.</p>
            * payment_intent_updated - <p class="mb-2">Sent when a Payment intent is updated</p>
            * payment_source_locally_deleted - <p class="mb-2">Sent when a payment source for a customer removed from Chargebee</p>
          enum:
          - plan_created
          - plan_updated
          - plan_deleted
          - addon_created
          - addon_updated
          - addon_deleted
          - coupon_created
          - coupon_updated
          - coupon_deleted
          - coupon_set_created
          - coupon_set_updated
          - coupon_set_deleted
          - coupon_codes_added
          - coupon_codes_deleted
          - coupon_codes_updated
          - customer_created
          - customer_changed
          - customer_deleted
          - customer_moved_out
          - customer_moved_in
          - promotional_credits_added
          - promotional_credits_deducted
          - subscription_created
          - subscription_created_with_backdating
          - subscription_started
          - subscription_trial_end_reminder
          - subscription_activated
          - subscription_activated_with_backdating
          - subscription_changed
          - subscription_trial_extended
          - mrr_updated
          - subscription_changed_with_backdating
          - subscription_cancellation_scheduled
          - subscription_cancellation_reminder
          - subscription_cancelled
          - subscription_canceled_with_backdating
          - subscription_reactivated
          - subscription_reactivated_with_backdating
          - subscription_renewed
          - subscription_items_renewed
          - subscription_scheduled_cancellation_removed
          - subscription_changes_scheduled
          - subscription_scheduled_changes_removed
          - subscription_shipping_address_updated
          - subscription_deleted
          - subscription_paused
          - subscription_pause_scheduled
          - subscription_scheduled_pause_removed
          - subscription_resumed
          - subscription_resumption_scheduled
          - subscription_scheduled_resumption_removed
          - subscription_advance_invoice_schedule_added
          - subscription_advance_invoice_schedule_updated
          - subscription_advance_invoice_schedule_removed
          - pending_invoice_created
          - pending_invoice_updated
          - invoice_generated
          - invoice_generated_with_backdating
          - invoice_updated
          - invoice_deleted
          - credit_note_created
          - credit_note_created_with_backdating
          - credit_note_updated
          - credit_note_deleted
          - subscription_renewal_reminder
          - transaction_created
          - transaction_updated
          - transaction_deleted
          - payment_succeeded
          - payment_failed
          - dunning_updated
          - payment_refunded
          - payment_initiated
          - refund_initiated
          - authorization_succeeded
          - authorization_voided
          - card_added
          - card_updated
          - card_expiry_reminder
          - card_expired
          - card_deleted
          - payment_source_added
          - payment_source_updated
          - payment_source_deleted
          - payment_source_expiring
          - payment_source_expired
          - payment_source_locally_deleted
          - virtual_bank_account_added
          - virtual_bank_account_updated
          - virtual_bank_account_deleted
          - token_created
          - token_consumed
          - token_expired
          - unbilled_charges_created
          - unbilled_charges_voided
          - unbilled_charges_deleted
          - unbilled_charges_invoiced
          - order_created
          - order_updated
          - order_cancelled
          - order_delivered
          - order_returned
          - order_ready_to_process
          - order_ready_to_ship
          - order_deleted
          - order_resent
          - quote_created
          - quote_updated
          - quote_deleted
          - tax_withheld_recorded
          - tax_withheld_deleted
          - tax_withheld_refunded
          - gift_scheduled
          - gift_unclaimed
          - gift_claimed
          - gift_expired
          - gift_cancelled
          - gift_updated
          - hierarchy_created
          - hierarchy_deleted
          - payment_intent_created
          - payment_intent_updated
          - contract_term_created
          - contract_term_renewed
          - contract_term_terminated
          - contract_term_completed
          - contract_term_cancelled
          - voucher_created
          - voucher_expired
          - voucher_create_failed
          - subscription_ramp_created
          - subscription_ramp_deleted
          - subscription_ramp_applied
          - subscription_ramp_drafted
          - subscription_ramp_updated
          - subscription_moved_in
          - subscription_moved_out
          - subscription_movement_failed
          - omnichannel_subscription_created
          - omnichannel_subscription_item_renewed
          - omnichannel_subscription_item_downgraded
          - omnichannel_subscription_item_expired
          - omnichannel_subscription_item_cancellation_scheduled
          - omnichannel_subscription_item_scheduled_cancellation_removed
          - omnichannel_subscription_item_resubscribed
          - omnichannel_subscription_item_upgraded
          - omnichannel_subscription_item_cancelled
          - omnichannel_subscription_imported
          - omnichannel_subscription_item_grace_period_started
          - omnichannel_subscription_item_grace_period_expired
          - omnichannel_subscription_item_dunning_started
          - omnichannel_subscription_item_dunning_expired
          - rule_created
          - rule_updated
          - rule_deleted
          - record_purchase_failed
          - omnichannel_subscription_item_change_scheduled
          - omnichannel_subscription_item_scheduled_change_removed
          - omnichannel_subscription_item_reactivated
          - sales_order_created
          - sales_order_updated
          - omnichannel_subscription_item_changed
          - omnichannel_subscription_item_paused
          - omnichannel_subscription_item_resumed
          - omnichannel_one_time_order_created
          - omnichannel_one_time_order_item_cancelled
          - usage_file_ingested
          - omnichannel_subscription_item_pause_scheduled
          example: null
        api_version:
          type: string
          default: v1
          deprecated: false
          description: |
            The Chargebee API Version used for rendering this event content. While processing webhooks, ensure this version is same as the API version used by your webhook server's client library.
            \* v1 -

            Chargebee API version V1
            \* v2 -

            Chargebee API version V2
          enum:
          - v1
          - v2
          example: null
        content:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            The JSON data associated with this event. Has resources (\*subscription\* , \*invoice\* etc) based on the \[event type\](/docs/api/v2/pcv-1/events/event-types). These resources are structured based on the Chargebee API version indicated by the \*api_version\* attribute.
          example: null
        origin_user:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The email address of the user, if captured, in the API operation that triggered the event. This email address is captured through either the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-user</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-user-encoded</code> <a href="/docs/api/advanced-features">custom HTTP request headers</a>.</p>
            <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Note</strong>:
            Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">event_source</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">api</code>.</p></div>
          example: null
        webhooks:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhook</code>
            object data is a queued operation and hence there can be an additional delay of up to 5 seconds.</p>
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a webhook
                maxLength: 40
                example: null
              webhook_status:
                type: string
                deprecated: false
                description: |-
                  <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed"><strong class="font-semibold">When the event resource is retrieved via API:</strong> Represents the status of the webhook call made to this webhook.</li>
                  <li class="text-base leading-relaxed"><strong class="font-semibold">When the event resource is passed as part of a webhook call:</strong> The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">webhooks</code> object is unavailable on the first webhook call for the event. For subsequent calls, this attribute holds the status from after the last retry.</li>
                  </ul>
                  * failed - <p class="mb-2">Webhook call has been suspended after the all retries have resulted in failure.</p>
                  * succeeded - <p class="mb-2">Webhook call was successful.</p>
                  * scheduled - <p class="mb-2">Webhook call has been scheduled.</p>
                  * re_scheduled - <p class="mb-2">Webhook call has been rescheduled due failure(s) in previous call(s)</p>
                  * not_applicable - <p class="mb-2">Webhook call is not applicable for this event.</p>
                  * skipped - <p class="mb-2">Skipped as specified in request</p>
                  * not_configured - <p class="mb-2">Webhook was not configured when this event occurred</p>
                enum:
                - not_configured
                - scheduled
                - succeeded
                - re_scheduled
                - failed
                - skipped
                - not_applicable
                - disabled
                - rate_limited
                example: null
            required:
            - id
            - webhook_status
            example: null
          example: null
      required:
      - content
      - id
      - occurred_at
      - source
      example: null
    EventName:
      type: string
      deprecated: false
      enum:
      - cancellation_page_loaded
      example: null
    EventType:
      type: string
      deprecated: false
      enum:
      - plan_created
      - plan_updated
      - plan_deleted
      - addon_created
      - addon_updated
      - addon_deleted
      - coupon_created
      - coupon_updated
      - coupon_deleted
      - coupon_set_created
      - coupon_set_updated
      - coupon_set_deleted
      - coupon_codes_added
      - coupon_codes_deleted
      - coupon_codes_updated
      - customer_created
      - customer_changed
      - customer_deleted
      - customer_moved_out
      - customer_moved_in
      - promotional_credits_added
      - promotional_credits_deducted
      - subscription_created
      - subscription_created_with_backdating
      - subscription_started
      - subscription_trial_end_reminder
      - subscription_activated
      - subscription_activated_with_backdating
      - subscription_changed
      - subscription_trial_extended
      - mrr_updated
      - subscription_changed_with_backdating
      - subscription_cancellation_scheduled
      - subscription_cancellation_reminder
      - subscription_cancelled
      - subscription_canceled_with_backdating
      - subscription_reactivated
      - subscription_reactivated_with_backdating
      - subscription_renewed
      - subscription_items_renewed
      - subscription_scheduled_cancellation_removed
      - subscription_changes_scheduled
      - subscription_scheduled_changes_removed
      - subscription_shipping_address_updated
      - subscription_deleted
      - subscription_paused
      - subscription_pause_scheduled
      - subscription_scheduled_pause_removed
      - subscription_resumed
      - subscription_resumption_scheduled
      - subscription_scheduled_resumption_removed
      - subscription_advance_invoice_schedule_added
      - subscription_advance_invoice_schedule_updated
      - subscription_advance_invoice_schedule_removed
      - pending_invoice_created
      - pending_invoice_updated
      - invoice_generated
      - invoice_generated_with_backdating
      - invoice_updated
      - invoice_deleted
      - credit_note_created
      - credit_note_created_with_backdating
      - credit_note_updated
      - credit_note_deleted
      - subscription_renewal_reminder
      - transaction_created
      - transaction_updated
      - transaction_deleted
      - payment_succeeded
      - payment_failed
      - dunning_updated
      - payment_refunded
      - payment_initiated
      - refund_initiated
      - authorization_succeeded
      - authorization_voided
      - card_added
      - card_updated
      - card_expiry_reminder
      - card_expired
      - card_deleted
      - payment_source_added
      - payment_source_updated
      - payment_source_deleted
      - payment_source_expiring
      - payment_source_expired
      - payment_source_locally_deleted
      - virtual_bank_account_added
      - virtual_bank_account_updated
      - virtual_bank_account_deleted
      - token_created
      - token_consumed
      - token_expired
      - unbilled_charges_created
      - unbilled_charges_voided
      - unbilled_charges_deleted
      - unbilled_charges_invoiced
      - order_created
      - order_updated
      - order_cancelled
      - order_delivered
      - order_returned
      - order_ready_to_process
      - order_ready_to_ship
      - order_deleted
      - order_resent
      - quote_created
      - quote_updated
      - quote_deleted
      - tax_withheld_recorded
      - tax_withheld_deleted
      - tax_withheld_refunded
      - gift_scheduled
      - gift_unclaimed
      - gift_claimed
      - gift_expired
      - gift_cancelled
      - gift_updated
      - hierarchy_created
      - hierarchy_deleted
      - payment_intent_created
      - payment_intent_updated
      - contract_term_created
      - contract_term_renewed
      - contract_term_terminated
      - contract_term_completed
      - contract_term_cancelled
      - voucher_created
      - voucher_expired
      - voucher_create_failed
      - subscription_ramp_created
      - subscription_ramp_deleted
      - subscription_ramp_applied
      - subscription_ramp_drafted
      - subscription_ramp_updated
      - subscription_moved_in
      - subscription_moved_out
      - subscription_movement_failed
      - omnichannel_subscription_created
      - omnichannel_subscription_item_renewed
      - omnichannel_subscription_item_downgraded
      - omnichannel_subscription_item_expired
      - omnichannel_subscription_item_cancellation_scheduled
      - omnichannel_subscription_item_scheduled_cancellation_removed
      - omnichannel_subscription_item_resubscribed
      - omnichannel_subscription_item_upgraded
      - omnichannel_subscription_item_cancelled
      - omnichannel_subscription_imported
      - omnichannel_subscription_item_grace_period_started
      - omnichannel_subscription_item_grace_period_expired
      - omnichannel_subscription_item_dunning_started
      - omnichannel_subscription_item_dunning_expired
      - rule_created
      - rule_updated
      - rule_deleted
      - record_purchase_failed
      - omnichannel_subscription_item_change_scheduled
      - omnichannel_subscription_item_scheduled_change_removed
      - omnichannel_subscription_item_reactivated
      - sales_order_created
      - sales_order_updated
      - omnichannel_subscription_item_changed
      - omnichannel_subscription_item_paused
      - omnichannel_subscription_item_resumed
      - omnichannel_one_time_order_created
      - omnichannel_one_time_order_item_cancelled
      - usage_file_ingested
      - omnichannel_subscription_item_pause_scheduled
      example: null
    ExcludeTaxType:
      type: string
      default: none
      deprecated: false
      enum:
      - exclusive
      - none
      example: null
    Export:
      type: object
      description: |
        Export resource represents an export job and contains the status of the job and the download URL, if the job is successfully completed.

        Export operations are asynchronous and will return "Export" resource in response . The export resource will contain the status of the export job (like in-process, completed...) . If the status is completed, it will contain the download url pointing to the zip/pdf containing the exported data.

        **Note:** At any given point, only 5 export jobs can be processed. Beyond that, an error stating that the API request limit has been reached will be returned.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier to identify the export
          maxLength: 50
          example: null
        operation_type:
          type: string
          deprecated: false
          description: |
            Describes the type of export
          maxLength: 100
          example: null
        mime_type:
          type: string
          default: zip
          deprecated: false
          description: |
            Describes the mime type of download file
            \* pdf -

            PDF
            \* zip -

            ZIP
          enum:
          - pdf
          - zip
          example: null
        status:
          type: string
          default: in_process
          deprecated: false
          description: |
            Current status of the export operation
            \* completed -

            Completed
            \* failed -

            Failed
            \* in_process -

            In Process
          enum:
          - in_process
          - completed
          - failed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Export created time
          example: null
        download:
          type: object
          deprecated: false
          description: |
            Returns the download_url for the export. The download URL is valid upto a specific date.
          properties:
            download_url:
              type: string
              deprecated: false
              description: |
                The URL at which the file is available for download.
              maxLength: 3500
              example: null
            valid_till:
              type: integer
              format: unix-time
              deprecated: false
              description: |-
                <p class="mb-2">The time until which the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">download_url</code>
                is valid.</p>
              example: null
            mime_type:
              type: string
              deprecated: false
              description: |
                The [media type](https://en.wikipedia.org/wiki/Media_type)
                of the file.
              maxLength: 100
              example: null
          required:
          - download_url
          - valid_till
          example: null
      required:
      - created_at
      - id
      - mime_type
      - operation_type
      - status
      example: null
    ExportType:
      type: string
      default: data
      deprecated: false
      enum:
      - data
      - import_friendly_data
      example: null
    FailedUsageEvent:
      type: object
      properties:
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        usage_timestamp:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        ingestion_timestamp:
          type: integer
          format: int64
          deprecated: false
          example: null
        properties:
          type: string
          deprecated: false
          example: null
        error_codes:
          type: array
          deprecated: false
          items:
            example: null
          example: null
        event_meta:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
      required:
      - error_codes
      - event_meta
      - ingestion_timestamp
      - properties
      - subscription_id
      example: null
    FeatureAvailabilityMetric:
      type: object
      properties:
        state:
          type: string
          deprecated: false
          enum:
          - draft
          - active
          - archived
          - deleted
          example: null
        count:
          type: integer
          format: int64
          deprecated: false
          example: null
        last_updated_at:
          type: integer
          format: int64
          deprecated: false
          example: null
      example: null
    FreePeriodUnit:
      type: string
      deprecated: false
      enum:
      - day
      - week
      - month
      - year
      example: null
    FriendOfferType:
      type: string
      deprecated: false
      enum:
      - none
      - coupon
      - coupon_code
      example: null
    FullExport:
      type: object
      description: |
        The Full Export API allows bulk download of various datasets from a secure location where data is loaded daily on a predefined schedule. Users can request dataset downloads by specifying the dataset name and date, among others. All the records of a given day (from 12:00 a.m. to 11:59 p.m. UTC) are available to query by the following day. The API responds with a download URL upon successful availability.
      properties:
        table:
          type: string
          deprecated: false
          description: |
            The name of the table from which the data has been exported. For example, invoices.
          maxLength: 200
          example: null
        status:
          type: string
          default: in_process
          deprecated: false
          description: |
            Represents the current status of the export. For example, Completed, In Progress, etc.
            \* failed -

            When the export is failed.
            \* completed -

            When the export is completed.
            \* in_process -

            When the export is in process.
          enum:
          - in_process
          - completed
          - failed
          example: null
        export_date:
          type: string
          format: date
          deprecated: false
          description: |
            The date for which the data is being exported. It's formatted in the YYYY-MM-DD format. For instance, if retrieving data relevant to September 10, 2023, the export_date would be 2023-09-10.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            A timestamp representing when the export was initiated. For example, 1693383422.
          example: null
        download:
          type: object
          deprecated: false
          description: |
            Returns the download_url for the export. The download URL is valid upto a specific date.
          properties:
            download_url:
              type: string
              deprecated: false
              description: |
                The URL at which the file is available for download.
              maxLength: 3500
              example: null
            valid_till:
              type: integer
              format: unix-time
              deprecated: false
              description: |-
                <p class="mb-2">The time until which the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">download_url</code>
                is valid.</p>
              example: null
            mime_type:
              type: string
              deprecated: false
              description: |
                The [media type](https://en.wikipedia.org/wiki/Media_type)
                of the file. This gives information on the file format/type. For example, application/x-parquet.
              maxLength: 100
              example: null
          required:
          - download_url
          - valid_till
          example: null
      required:
      - created_at
      - export_date
      - status
      - table
      example: null
    Gateway:
      type: string
      deprecated: true
      enum:
      - chargebee
      - chargebee_payments
      - adyen
      - stripe
      - wepay
      - braintree
      - authorize_net
      - paypal_pro
      - pin
      - eway
      - eway_rapid
      - worldpay
      - balanced_payments
      - beanstream
      - bluepay
      - elavon
      - first_data_global
      - hdfc
      - migs
      - nmi
      - ogone
      - paymill
      - paypal_payflow_pro
      - sage_pay
      - tco
      - wirecard
      - amazon_payments
      - paypal_express_checkout
      - orbital
      - moneris_us
      - moneris
      - bluesnap
      - cybersource
      - vantiv
      - checkout_com
      - paypal
      - ingenico_direct
      - exact
      - mollie
      - quickbooks
      - razorpay
      - global_payments
      - bank_of_america
      - ecentric
      - metrics_global
      - windcave
      - pay_com
      - ebanx
      - dlocal
      - nuvei
      - solidgate
      - paystack
      - jp_morgan
      - deutsche_bank
      - ezidebit
      - twikey
      - tempus
      - moyasar
      - payway
      - gocardless
      - not_applicable
      example: null
    GatewayErrorDetail:
      type: object
      description: ""
      properties:
        request_id:
          type: string
          deprecated: false
          description: |
            This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
          maxLength: 100
          example: null
        error_category:
          type: string
          deprecated: false
          description: |
            This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
          maxLength: 100
          example: null
        error_code:
          type: string
          deprecated: false
          description: |
            A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
          maxLength: 100
          example: null
        error_message:
          type: string
          deprecated: false
          description: |
            A message provided by the gateway that describes the nature of the error encountered
          maxLength: 65000
          example: null
        decline_code:
          type: string
          deprecated: false
          description: |
            When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
          maxLength: 100
          example: null
        decline_message:
          type: string
          deprecated: false
          description: |
            This message gives a descriptive explanation of the reason for the transaction's decline
          maxLength: 65000
          example: null
        network_error_code:
          type: string
          deprecated: false
          description: |
            This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
          maxLength: 100
          example: null
        network_error_message:
          type: string
          deprecated: false
          description: |
            This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered
          maxLength: 65000
          example: null
        error_field:
          type: string
          deprecated: false
          description: |
            This parameter indicates which specific data field or attribute in the request caused the error
          maxLength: 100
          example: null
        recommendation_code:
          type: string
          deprecated: false
          description: |
            After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
          maxLength: 100
          example: null
        recommendation_message:
          type: string
          deprecated: false
          description: |
            This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
          maxLength: 65000
          example: null
        processor_error_code:
          type: string
          deprecated: false
          description: |
            This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
          maxLength: 100
          example: null
        processor_error_message:
          type: string
          deprecated: false
          description: |
            This message describes the specific error that the payment processor encountered
          maxLength: 65000
          example: null
        error_cause_id:
          type: string
          deprecated: false
          maxLength: 150
          example: null
        processor_advice_code:
          type: string
          deprecated: false
          description: "<p class=\"mb-2\">An advice code from the payment gateway\
            \ or network that indicates how to handle a card decline. For example,\
            \ the value <code class=\"bg-gray-100 text-gray-800 font-medium border\
            \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
            >try_again_later</code> means you can retry the transaction.</p>"
          maxLength: 100
          example: null
      example: null
    Gift:
      type: object
      description: |
        Gift represents a subscription of a customer(**recipient** ) to a 'gift plan' which has been gifted by another customer(**gifter**). It may also have addons and coupons. Gift will be created only on immediate successful payment collection from the gifter's payment method.

        Gift is initially created in '**scheduled** ' state. The gift can be scheduled to be notified on a particular date to the recipient by passing 'scheduled_at'. If not, the recipient is notified immediately. Gift will be moved to '**unclaimed** ' state on the date of notification. If you pass auto_claim as true, gift status will be moved to '**claimed**' immediately, otherwise, the gift will remain 'unclaimed' till the recipient claims the gift.

        If the gift is not claimed before the claim_expiry_date, it will be moved to the '**expired**' state.

        #### GIFT SUBSCRIPTION

        Gift subscriptions will be created in '**future** ' state. Once the gift is claimed, the subscription will be moved to '**non-renewing**' state.

        #### INVOICE

        Gift subscriptions will be invoiced immediately. The invoice created has **is_gifted** as 'true' and **term_finalized** as 'false'. This is because initially the invoice term_start and term_end are set as the subscription's start_date till the end of the plan period. Once the gift is claimed, the invoice's term_finalized will be marked as 'true'. The term_start will be changed to the actual invoice's term, which is the gift-claim date and the term_end will be changed till plan's period.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies a gift
          maxLength: 150
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the gift.
            \* claimed -

            Gift is claimed.
            \* cancelled -

            Gift is cancelled.
            \* unclaimed -

            Gift is not yet claimed and is ready to be claimed.
            \* scheduled -

            Gift has been scheduled.
            \* expired -

            Gift is expired.
          enum:
          - scheduled
          - unclaimed
          - claimed
          - cancelled
          - expired
          example: null
        scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
          example: null
        auto_claim:
          type: boolean
          default: false
          deprecated: false
          description: |-
            <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , the claim happens automatically. When not passed, the default value in the site settings is used.</p>
          example: null
        no_expiry:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , indicates that the gift does not expire. Do not pass or pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
            is set.</p>
          example: null
        claim_expiry_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The date until which the gift can be claimed. Must be set to a value after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheduled_at</code>.
            If the gift is not claimed within <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">claim_expiry_date</code>
            , it will expire and the subscription will move to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
            state. When not passed, the value specified in the site settings will be used.
            Pass as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NULL</code>
            or do not pass when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">auto_claim</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">no_expiry</code>
            are set.</p>
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this gift resource was last updated.
          example: null
        gifter:
          type: object
          deprecated: false
          description: |
            Gifter details
          properties:
            customer_id:
              type: string
              deprecated: false
              description: |
                Gifter customer id.
              maxLength: 50
              example: null
            invoice_id:
              type: string
              deprecated: false
              description: |
                Invoice raised on the gifter.
              maxLength: 50
              example: null
            signature:
              type: string
              deprecated: false
              description: |
                Gifter sign-off name
              maxLength: 50
              example: null
            note:
              type: string
              deprecated: false
              description: |
                Personalized message for the gift.
              maxLength: 500
              example: null
          required:
          - customer_id
          example: null
        gift_receiver:
          type: object
          deprecated: false
          description: |
            Receiver details
          properties:
            customer_id:
              type: string
              deprecated: false
              description: |
                Receiver customer id.
              maxLength: 50
              example: null
            subscription_id:
              type: string
              deprecated: false
              description: |
                Subscription created for the gift.
              maxLength: 50
              example: null
            first_name:
              type: string
              deprecated: false
              description: |
                First name of the receiver as given by the gifter.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                Last name of the receiver as given by the gifter,
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Email of the receiver. All gift related emails are sent to this email.
              maxLength: 70
              example: null
          required:
          - customer_id
          - subscription_id
          example: null
        gift_timelines:
          type: array
          deprecated: false
          description: |
            Gift timeline details
          items:
            type: object
            deprecated: false
            properties:
              status:
                type: string
                deprecated: false
                description: |
                  Status of the gift.
                  \* cancelled -

                  Gift is cancelled.
                  \* expired -

                  Gift is expired.
                  \* scheduled -

                  Gift has been scheduled.
                  \* claimed -

                  Gift is claimed.
                  \* unclaimed -

                  Gift is not yet claimed and is ready to be claimed.
                enum:
                - scheduled
                - unclaimed
                - claimed
                - cancelled
                - expired
                example: null
              occurred_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this event occurred.
                example: null
            required:
            - status
            example: null
          example: null
      required:
      - auto_claim
      - gift_receiver
      - gifter
      - id
      - no_expiry
      - status
      example: null
    GiftCancelledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GiftClaimedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GiftExpiredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GiftScheduledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GiftUnclaimedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GiftUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            gift:
              $ref: "#/components/schemas/Gift"
          required:
          - gift
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Hierarchy:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">When a customer belongs to an <a href="https://www.chargebee.com/docs/1.0/account-hierarchy.html" target="_blank">account hierarchy</a>, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hierarchy</code> resource represents the customer&#x27;s position within that hierarchy. The hierarchy provides details about the customer&#x27;s parent, children, invoice owner, and payment owner.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">A customer can have a maximum of 250 direct children.</li>
        <li class="text-base leading-relaxed">The hierarchy allows a maximum of 5 levels from the root node to the lowest child node.</li>
        </ul></div><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Related Endpoints</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/customers/get-hierarchy">Get hierarchy</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/customers/update-hierarchy-access-settings-for-a-customer">Update hierarchy access settings</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/customers/link-a-customer">Link a customer to a hierarchy</a>
        </li>
        <li class="text-base leading-relaxed">
        <a href="/docs/api/v2/pcv-1/customers/delink-a-customer">Delink a customer from a hierarchy</a>
        </li>
        </ul></div></div>
      properties:
        customer_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the customer associated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hierarchy</code>
            resource.</p>
          maxLength: 50
          example: null
        parent_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the immediate parent for the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>.
            If the customer is the root of the hierarchy, this attribute isn&#x27;t returned.</p>
          maxLength: 50
          example: null
        payment_owner_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the customer responsible for paying the invoices for the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>.
            This ID must match either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_owner_id</code>
            .</p>
          maxLength: 50
          example: null
        invoice_owner_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the customer who receives the invoice for charges incurred by the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>.
            This ID must match either <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
            or one of its ancestors.</p>
          maxLength: 50
          example: null
        has_children:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the customer has child accounts in the hierarchy.
          example: null
        children_ids:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">A list of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            s representing the immediate children, if any exist, for the customer identified by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>
            .</p>
          items:
            type: string
            deprecated: false
            maxLength: 50
            example: null
          example: null
      required:
      - customer_id
      - invoice_owner_id
      - payment_owner_id
      example: null
    HierarchyCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    HierarchyDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    HierarchyOperationType:
      type: string
      deprecated: false
      enum:
      - complete_hierarchy
      - subordinates
      - path_to_root
      example: null
    HostedPage:
      type: object
      description: |
        Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.

        When you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.

        Specifying **"embed"** parameter as **true** allows you to embed the "hosted page" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:

        * Your site URL must be embedded with HTTPS.
        * Set the appropriate height and width for the iframe to avoid scrolling.

        To use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.

        * **id** - unique identifier of the hosted page resource
        * **state** - succeeded, failed or cancelled

        After the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.

        [Checkout New Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription):

        * [Customer](/docs/api/customers/customer-object) - The details about the new customer created.
        * [Subscription](/docs/api/subscriptions/subscription-object) - The details about the new subscription created.
        * [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.
        * [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.

        [Checkout Existing Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-existing-subscription):

        * [Customer](/docs/api/customers/customer-object) - The updated details of the customer.
        * [Subscription](/docs/api/subscriptions/subscription-object) - The updated details of the subscription.
        * [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.
        * [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.

        [Update Payment Method](/docs/api/v2/pcv-1/hosted_pages/update-payment-method):

        * [Customer](/docs/api/customers/customer-object) - The details about the customer for whom the card was updated.
        * [Card](/docs/api/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card.

        When an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier generated for each hosted page requested.
          maxLength: 70
          example: null
        type:
          type: string
          deprecated: false
          description: |
            Type of the requested hosted page.
            \* collect_now -

            Collect Unpaid Invoices for a Customer
            \* checkout_gift -

            Checkout a gift subscription
            \* checkout_new -

            Checkout new Subscription
            \* extend_subscription -

            To extend a Subscription period
            \* checkout_one_time -

            Checkout one time
            \* update_payment_method -

            Update Payment Method for a Customer
            \* view_voucher -

            View Details of a voucher
            \* pre_cancel -

            This hosted page is used to help retain customers when they attempt to cancel their account or subscription.
            \* manage_payment_sources -

            Manage Payments for a customer
            \* checkout_existing -

            Checkout existing Subscription
            \* claim_gift -

            Claim a gift subscription
          enum:
          - checkout_new
          - checkout_existing
          - update_payment_method
          - manage_payment_sources
          - collect_now
          - extend_subscription
          - checkout_gift
          - claim_gift
          - checkout_one_time
          - pre_cancel
          - view_voucher
          - accept_quote
          example: null
        url:
          type: string
          deprecated: false
          description: |
            Unique URL for the hosted page that will be included in your website.
          maxLength: 250
          example: null
        state:
          type: string
          default: created
          deprecated: false
          description: |
            Indicating the current state of the hosted page resource.
            \* acknowledged -

            Indicates the succeeded hosted page is acknowledged.
            \* created -

            Indicates the hosted page is just created.
            \* requested -

            Indicates the hosted page is requested by the website
            \* cancelled -

            Indicates the page is cancelled by the end user after requesting it.
            \* succeeded -

            Indicates the hosted page is successfully submitted by the user and response is sent to the return url.
          enum:
          - created
          - requested
          - succeeded
          - cancelled
          - acknowledged
          example: null
        pass_thru_content:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This attribute allows you to store custom information with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">hosted_page</code> object. You can use it to associate specific data with a hosted page session.
            For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the <a href="/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription#redirect_url">redirect URL</a>&#x27;s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.</p>
          maxLength: 2048
          example: null
        embed:
          type: boolean
          default: true
          deprecated: false
          description: |
            If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

            **Note**
            : For [in-app](https://www.chargebee.com/docs/checkout-v3.html)
            checkout, default is false.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates when this hosted page url is generated.
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The date and time when the hosted page URL expires. After this timestamp, the page can no longer be accessed.
            The expiration period depends on the <code><a href="/docs/api/v2/pcv-1/hosted_pages/hosted_page-object#type">type</a></code> of hosted page:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_new</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_existing</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_one_time</code>, the URL expires 3 hours after the page is created.</li>
            <li class="text-base leading-relaxed">For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">collect_now</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manage_payment_sources</code>, the URL expires 5 days after creation.</li>
            </ul>
          example: null
        content:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            This attribute will be returned only during retrieve hosted page API call and also the retrieved hosted page resource state should be either in "succeeded" or "cancelled" state. If hosted page state is "succeeded", then the subscription, customer, card \\\& invoice(optional) resources during checkout can be obtained. If hosted page is state is "cancelled", then it will be empty i.e no information about checkout.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this hosted page was last updated.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The version number of this resource. For every change made to the resource, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds.</p>
          example: null
        checkout_info:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            Customer Info (email, first name and last name) given in the checkout page used for tracking abandoned carts. \[Learn more\](https://www.chargebee.com/docs/abandoned-carts.html)
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
      required:
      - content
      - embed
      example: null
    InAppSubscription:
      type: object
      description: "**Important:**\n\nThese APIs operate asynchronously. When you\
        \ receive a successful response code from an API call, it indicates only the\
        \ successful submission of your request, not the completion of the operation.\n\
        \nUsing In-app Subscriptions, you can track subscriptions you sell and service\
        \ via in-app purchase channels such as Apple's App Store and Google's Play\
        \ Store. Call [this API](/docs/api/in_app_subscriptions/process-purchase-command)\
        \ to notify Chargebee of new subscription purchases. Chargebee responds by\
        \ creating corresponding subscriptions. You can make the API call directly\
        \ from the client-side application or from your server. In the case of the\
        \ Apple App Store and Google Play Store integration, you can also configure\
        \ Chargebee to receive server notifications from [Apple](https://developer.apple.com/documentation/appstoreservernotifications)\
        \ and [Google](https://developer.android.com/google/play/billing/rtdn-reference#sub)\
        \ to keep subscriptions up-to-date.  \n**Note:**\n\nAfter creating a subscription\
        \ in Chargebee using the [process purchase command](/docs/api/in_app_subscriptions/process-purchase-command)\
        \ API, Chargebee manages it in real-time using notification events from [Apple](/docs/api/in_app_purchase_events)\
        \ or [Google](/docs/api/in_app_purchase_events). To enable these notifications,\
        \ generate a notification URL using these links - [Apple](https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#connection-keys_notification-url)\
        \ and [Google](https://www.chargebee.com/docs/2.0/mobile-playstore-notifications.html)\
        \ and configure it in their respective stores.  \n**In-app subscriptions are\
        \ read-only**\n\nThe subscriptions created via the [Process Purchase Command\
        \ API](/docs/api/in_app_subscriptions/process-purchase-command) are managed\
        \ by Apple or Google in response to actions taken by your subscribers via\
        \ their respective accounts. Chargebee only keeps track of these subscriptions:\
        \ creating and modifying them in response to events happening against the\
        \ original subscriptions. Consequently, these subscriptions cannot be modified\
        \ by you via the Chargebee admin console or the [Subscriptions API](/docs/api/subscriptions).\n"
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the <a href="/docs/api/subscriptions/subscription-object#id">subscription</a>
            for which the receipt was sent.</p>
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the <a href="/docs/api/customers/customer-object#id">customer</a>
            object to which the subscription belongs.</p>
          maxLength: 100
          example: null
        plan_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_id</code>
            of the of the subscription.</p>
          maxLength: 100
          example: null
        store_status:
          type: string
          deprecated: false
          description: |
            The status of the subscription for the store
            \* paused -

            When the subscription is paused.
            \* in_trial -

            When the subscription is in trial.
            \* active -

            When the subscription is active.
            \* cancelled -

            When the subscription is cancelled.
          enum:
          - in_trial
          - active
          - cancelled
          - paused
          example: null
        invoice_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the invoice generated in Chargebee</p>
          maxLength: 100
          example: null
      required:
      - subscription_id
      example: null
    Invoice:
      type: object
      additionalProperties: true
      description: "Invoices are statements containing charges, adjustments and any\
        \ discounts for a subscription specific to a term. For every subscription\
        \ a draft invoice (upcoming invoice) is used to track all the charges, credits\
        \ and adjustments for the current term.\n\nGenerally, an invoice is closed\
        \ at start of the next term. However, cancellation and other such operations\
        \ on subscription may trigger premature closing. While closing the invoice,\
        \ in addition to recurring charges, credits and coupons are applied to calculate\
        \ the final amount that is due.\n\nWhen invoice is closed, an attempt to charge\
        \ the credit card is made. If the payment succeeds, it is marked as **paid**\
        \ . If the payment fails, the invoice is marked as **payment_due** and retry\
        \ settings are taken into account. If no retry attempts are configured, the\
        \ invoice is marked as **not_paid** . If the amount due is zero or negative,\
        \ the invoice is immediately marked as **paid** and the balance if any is\
        \ carried forward to the next term of the invoice.  \n**Note:**\nIf *consolidated\
        \ invoicing*\nis enabled, the attribute *invoice.subscription_id*\nshould\
        \ **not**\nbe used (as it will not be present if the invoice has lines from\
        \ multiple subscriptions). Instead to know the related subscriptions, their\
        \ [line_items](/docs/api/invoices/invoice-object#line_items)\n*subscription_id*\n\
        attribute should be referred.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The invoice number. Acts as a identifier for invoice and typically generated sequentially.
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The identifier of the customer this invoice belongs to.
          maxLength: 50
          example: null
        payment_owner:
          type: string
          deprecated: false
          description: |
            Payment owner of an invoice
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The identifier of the subscription this invoice belongs to.
            <strong class="font-semibold">Note</strong>:
            When consolidated invoicing is enabled, you have to refer to <a href="/docs/api/invoices/invoice-object#line_items">line_item`s</a>
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code>
            to identify the subscriptions associated with this invoice. However, it is important to avoid using this attribute if the invoice includes charges from multiple subscriptions, as it will be null in such cases.</p>
          maxLength: 50
          example: null
        recurring:
          type: boolean
          default: true
          deprecated: false
          description: |
            Boolean indicating whether this invoice belongs to a subscription
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Current status of this invoice.</p>
            * paid - <p class="mb-2">Indicates a paid invoice.</p>
            * posted - <p class="mb-2">Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period</p>
            * pending - <p class="mb-2">The <a href="/docs/api/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when it has line items that belong to items that are <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> or when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.create_pending_invoices</code>attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
            The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site.</p>
            * payment_due - <p class="mb-2">Indicates the payment is not yet collected and is being retried as per retry settings.</p>
            * not_paid - <p class="mb-2">Indicates the payment is not made and all attempts to collect is failed.</p>
            * voided - <p class="mb-2">Indicates a voided invoice.</p>
          enum:
          - paid
          - posted
          - payment_due
          - not_paid
          - voided
          - pending
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The document date displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>
            , and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.</p>
          example: null
        due_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Due date of the invoice
          example: null
        net_term_days:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: |
            Number of days within which the invoice has to be paid
          example: null
        po_number:
          type: string
          deprecated: false
          description: |
            Purchase Order Number for this invoice
          maxLength: 100
          example: null
        vat_number:
          type: string
          deprecated: false
          description: |
            VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)
          maxLength: 20
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          description: |
            The price type of the invoice.
            \* tax_exclusive -

            All amounts in the document are exclusive of tax.
            \* tax_inclusive -

            All amounts in the document are inclusive of tax.
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        exchange_rate:
          type: number
          format: decimal
          deprecated: false
          description: |
            Exchange rate used for base currency conversion.Note that when converting foreign currency invoices to local currency for VAT purposes, the exchange rates used differ from the base currency exchange rate provided in this field. This is due to regulations set by tax authorities, which require the use of official sources such as European Central Bank rates for local currency conversion.
          maximum: 1000000000
          minimum: 0.0000000010
          example: null
        local_currency_exchange_rate:
          type: number
          format: decimal
          deprecated: false
          description: |
            This parameter represents the exchange rate as a relative price of the base currency that appears as local currency in invoices and credit notes. The local currency exchange rate specifically refers to the exchange rate of a country's currency when converting it to another currency.

            For example, if you want to convert US dollars to euros, the local currency exchange rate would be the rate at which you can convert US dollars to euros.
          maximum: 1000000000
          minimum: 0.0000000010
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the invoice
          maxLength: 3
          example: null
        local_currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.
          maxLength: 3
          example: null
        tax:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total tax amount for this invoice
          minimum: 0
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The sum of all the line item amounts minus the sum of all line item discounts. In other words, this is the sum of all <code><a href="/docs/api/invoices/invoice-object#line_items">line_items[]</a>.amount</code></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">the sum of all <code><a href="/docs/api/invoices/invoice-object#line_item_discounts">line_item_discounts[]</a>.discount_amount</code>.</li>
            </ul>
          minimum: 0
          example: null
        sub_total_in_local_currency:
          type: integer
          format: int64
          deprecated: false
          description: |
            Invoice subtotal in the currency of the place of supply.
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          deprecated: false
          description: |
            Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
          minimum: 0
          example: null
        total_in_local_currency:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total invoice amount in the currency of the place of supply.
          minimum: 0
          example: null
        amount_due:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">
            <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code>
            </li>
            <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li>
            <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li>
            <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.</li>
            </ul>
          minimum: 0
          example: null
        amount_adjusted:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Total adjustments made against this invoice.
          minimum: 0
          example: null
        amount_paid:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
            for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
            that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>.</p>
          minimum: 0
          example: null
        paid_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating the date \& time this invoice got paid.
          example: null
        write_off_amount:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Amount written off against this invoice.
          minimum: 0
          example: null
        credits_applied:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Total credits applied against this invoice.
          minimum: 0
          example: null
        dunning_status:
          type: string
          deprecated: false
          description: |
            Current dunning status of the invoice.
            \* exhausted -

            Maximum number of attempts have been made.
            \* stopped -

            Dunning has stopped for this invoice.
            \* success -

            Payment successfully collected during dunning process.
            \* in_progress -

            Dunning is still in progress.
          enum:
          - in_progress
          - exhausted
          - stopped
          - success
          example: null
        next_retry_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when will the next attempt to collect payment for this invoice occur.
          example: null
        voided_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating the date \& time this invoice got voided.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The version number of this resource. For every change made to the resource, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this invoice was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
            **Note** :
            This value does not change when the following attributes are changed: *next_retry_at, dunning_status, has_advance_charges*
          example: null
        line_items_next_offset:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This attribute is returned only if additional resources are available. Use this value as the input parameter for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items_offset</code> to retrieve the next set of resources.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li>
            <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this feature.</li>
            </ul></div>
          maxLength: 1000
          example: null
        first_invoice:
          type: boolean
          deprecated: false
          description: |
            Boolean indicating the first invoice raised for the subscription. In the case of a non-recurring invoice, it indicates the first invoice raised for the customer.
          example: null
        new_sales_amount:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The share of the invoice total due to new sales. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_invoice</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , this attribute is the same as total. However, when the invoice is a <a href="https://www.chargebee.com/docs/2.0/consolidated-invoicing.html " target="_blank">consolidated</a>
            one, then it is the sum of all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.amount</code>
            belonging to a new.</p>
          minimum: 0
          example: null
        has_advance_charges:
          type: boolean
          deprecated: false
          description: |
            Boolean indicating any advance charge is present in this invoice.
          example: null
        term_finalized:
          type: boolean
          default: true
          deprecated: false
          description: |
            Boolean indicating this invoice line_items terms are finalized or not.
          example: null
        is_gifted:
          type: boolean
          default: false
          deprecated: false
          description: |
            Boolean indicating this invoice is gifted or not.
          example: null
        generated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The date when the invoice is finalized. This is the date in the invoice lifecycle when its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
            becomes any one of the following for the first time: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">posted</code>
            , or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paid</code>.
            For an invoice with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code>
            , this happens when it gets closed.</p>
          example: null
        expected_payment_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date and time at which [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) should resume automatically for the invoice. This attribute is present only if dunning is currently [paused](/docs/api/v2/pcv-1/invoices/pause-dunning-for-invoice) for the invoice.
            **See also** : [Dunning resumption process](/docs/api/v2/pcv-1/invoices/resume-dunning-for-invoice).
          example: null
        amount_to_collect:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Payments that are yet to be collected for the invoice. This is the same value as <code><a href="/docs/api/invoices/invoice-object#amount_due">amount_due</a></code></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code>
            for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code>
            that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_progress</code>.</li>
            </ul>
          minimum: 0
          example: null
        round_off_amount:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round_off_amount</code>.
            If there is no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">round-off amount</code>
            , it will display <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>
            .</p>
          minimum: 0
          example: null
        void_reason_code:
          type: string
          deprecated: false
          description: |
            Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Invoices \> Void invoice**.
            Must be passed if set as mandatory in the app. The codes are case-sensitive
          maxLength: 100
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        tax_category:
          type: string
          deprecated: false
          description: |
            Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.
          example: null
        vat_number_prefix:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
            Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
            ).</p>
            <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
            in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
            the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
            That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
            The first two characters of the VAT number in such a case is
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
            Set
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
            to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
            for such cases.</p>
          maxLength: 10
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\\* app_store -\n\nThe object data is synchronized with\
            \ data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Apple App Store. Direct manipulation of this object via UI\
            \ or API is disallowed.\n\\* play_store -\n\nThe object data is synchronized\
            \ with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Google Play Store. Direct manipulation of this object via UI\
            \ or API is disallowed.  \nIn-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\nfor more\
            \ information.\n\\* web -\n\nThe object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            The list of line items for this invoice
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the subscription this line item belongs to.
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of this line item.
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of this line item.
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Unit amount of the line item.
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |+
                  [Quantity of the recurring item](/docs/api/invoices/invoice-object#line_items_quantity) represented by this line item.
                  For metered line items, this value is updated from [usages](/docs/api/usages) when:

                  * the invoice is generated as pending

                  * the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)

                  * the sync usages API is called

                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of this line item. Typically equals to unit amount x quantity
                example: null
              pricing_model:
                type: string
                deprecated: false
                description: |
                  The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                  for this item.
                  \* per_unit -

                  A fixed price per unit quantity.
                  \* volume -

                  The per unit price is based on the tier that the total quantity falls in.
                  \* stairstep -

                  A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  \* flat_fee -

                  A fixed price that is not quantity-based.
                  \* tiered -

                  There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Specifies whether this line item is taxed or not
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The tax amount charged for this item
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                description: |
                  Rate of tax used to calculate tax for this lineitem
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                  x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                  Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total discounts for this line
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Line Item-level discounts for this line.
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                description: |
                  Invoice Reference Line Item ID
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this line item.
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this item.
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this line item is based on.
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                  * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                  * tax_not_configured_external_provider - <p class="mb-2">If the tax is not configured for the country in 3rd party tax provider.</p>
                  * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                  * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                  * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                  * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                  * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                  * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                  * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                  * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                  and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                  have not been provided for the customer and subscription respectively</p>
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this line item belongs to
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_tiers:
          type: array
          deprecated: false
          description: |
            The list of tiers applicable for this line item
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of units purchased in a range.
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                  pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  pricing.</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          description: |
            The list of deduction(s) applied for each line item of this invoice
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique id of the line item that this deduction is for.
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case.</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a coupon, then this is the id of the coupon.
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied on line items
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the tax is applicable
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The rate of tax used to calculate tax amount
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period end of the tax rate for the line item.
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period start of the tax rate for the line item.
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Indicates the prorated line item amount in cents.
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                description: |
                  Indicates if tax is applied only on a portion of the line item amount.
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                description: |
                  Indicates the non-compliance tax that should not be reported to the.
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Indicates the actual portion of the line item amount that is taxable.
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                description: |
                  The type of tax jurisdiction
                  \* federal -

                  The tax jurisdiction is a federal
                  \* state -

                  The tax jurisdiction is a state
                  \* city -

                  The tax jurisdiction is a city
                  \* special -

                  Special tax jurisdiction.
                  \* unincorporated -

                  Combined tax of state and county.
                  \* county -

                  The tax jurisdiction is a county
                  \* country -

                  The tax jurisdiction is a country
                  \* other -

                  Jurisdictions other than the ones listed above.
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax jurisdiction
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                description: |
                  The tax jurisdiction code
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        line_item_credits:
          type: array
          deprecated: false
          description: |
            A list of store credits applied to line items.
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                description: |
                  The ID of the credit note from which this credit is applied.
                maxLength: 50
                example: null
              applied_amount:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The credit amount applied to the line item.
                example: null
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique ID of the line item to which this credit is applied.
                maxLength: 40
                example: null
            required:
            - applied_amount
            - cn_id
            example: null
          example: null
        line_item_addresses:
          type: array
          deprecated: false
          description: |
            The list of addresses used for tax calculation on line items.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  Line item reference
                maxLength: 40
                example: null
              first_name:
                type: string
                deprecated: false
                description: |
                  First name of the customer
                maxLength: 150
                example: null
              last_name:
                type: string
                deprecated: false
                description: |
                  Last name of the customer
                maxLength: 150
                example: null
              email:
                type: string
                format: email
                deprecated: false
                description: |
                  Email address of the customer
                maxLength: 70
                example: null
              company:
                type: string
                deprecated: false
                description: |
                  Name of the company
                maxLength: 250
                example: null
              phone:
                type: string
                deprecated: false
                description: |
                  Phone number of the customer
                maxLength: 50
                example: null
              line1:
                type: string
                deprecated: false
                description: |
                  Address line 1
                maxLength: 150
                example: null
              line2:
                type: string
                deprecated: false
                description: |
                  Address line 2
                maxLength: 150
                example: null
              line3:
                type: string
                deprecated: false
                description: |
                  Address line 3
                maxLength: 150
                example: null
              city:
                type: string
                deprecated: false
                description: |
                  Name of the city
                maxLength: 50
                example: null
              state_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                  without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                  as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                  ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                  ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                  (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                  ).</p>
                maxLength: 50
                example: null
              state:
                type: string
                deprecated: false
                description: |
                  State or Province
                maxLength: 50
                example: null
              country:
                type: string
                deprecated: false
                description: "The billing address of the customer, specified as an\
                  \ [ISO 3166 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html).\n\
                  Entering an invalid code will return an error.  \nIf [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                  \ (2021 or later) or [Brexit configuration](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                  \ is enabled, 'United Kingdom-Northern Ireland' is a valid option.\n"
                maxLength: 50
                example: null
              zip:
                type: string
                deprecated: false
                description: |
                  Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                  .
                maxLength: 20
                example: null
              validation_status:
                type: string
                default: not_validated
                deprecated: false
                description: |
                  The address verification status.
                  \* partially_valid -

                  The address is valid for taxability but has not been validated for shipping.
                  \* invalid -

                  Address is invalid.
                  \* not_validated -

                  Address is not yet validated.
                  \* valid -

                  Address was validated successfully.
                enum:
                - not_validated
                - valid
                - partially_valid
                - invalid
                example: null
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            The list of all deductions applied to the invoice.
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description for this deduction.
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                  .</p>
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice.</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                  , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  of the coupon.</p>
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                  , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                  is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied for this invoice
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied. E.g. GST.
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description of the tax item.
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
        tax_origin:
          type: object
          deprecated: false
          description: |
            It represents information about the tax details that are applied to an invoice. Additionally, it specifies the country from which the tax is applied, as well as the relevant tax registration number.
          properties:
            country:
              type: string
              deprecated: false
              description: |
                The country code in ([ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)
                ) where the tax originated from.
              maxLength: 50
              example: null
            registration_number:
              type: string
              deprecated: false
              description: |
                It represents the tax registration number for the entity used to collect tax.
              maxLength: 100
              example: null
          example: null
        linked_taxes_withheld:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">Details of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_withheld</code>
            against this invoice.</p>
            <span featureId="cb-tax-withheld" isMicro="true"></span>
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_</code>.
                  For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_16BdDXSlbu4uV1Ee6</code>
                  .</p>
                maxLength: 40
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 1
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  The description for this tax withheld.
                maxLength: 65000
                example: null
              date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Date or time associated with the tax withheld.
                example: null
              reference_number:
                type: string
                deprecated: false
                description: |
                  A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
                maxLength: 100
                example: null
            required:
            - id
            example: null
          example: null
        linked_payments:
          type: array
          deprecated: false
          description: |
            The list of transactions for this invoice
          items:
            type: object
            deprecated: false
            properties:
              txn_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the transaction.
                maxLength: 40
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The transaction amount applied to this invoice
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp at which the transaction is applied.
                example: null
              txn_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of this transaction.</p>
                  * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                  * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                  * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                  * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                  * success - <p class="mb-2">The transaction is successful.</p>
                  * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                  * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                  for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                  transaction to be reconciled at par with the gateway.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transaction status</p></div>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              txn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates when this transaction occurred.
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of the transaction
                minimum: 0
                example: null
            required:
            - applied_amount
            - applied_at
            - txn_id
            example: null
          example: null
        reference_transactions:
          type: array
          deprecated: false
          description: |
            A list of up to 20 transactions for this invoice. The list can contain authorizations and payments. Transactions are sorted by creation date in ascending order.
          items:
            type: object
            deprecated: false
            properties:
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount from the transaction that was applied to the invoice.
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The time when the transaction was applied to the invoice, in seconds since the Unix epoch.
                example: null
              txn_id:
                type: string
                deprecated: false
                description: |
                  The unique identifier for the transaction.
                maxLength: 40
                example: null
              txn_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of the transaction.</p>
                  * timeout - <p class="mb-2">The transaction failed because the gateway did not accept the connection.</p>
                  * success - <p class="mb-2">The transaction was successful.</p>
                  * in_progress - <p class="mb-2">The transaction is being processed by the gateway. This typically occurs for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, for cards, refund transactions. Processing can take 2-7 days, depending on the gateway and payment method.</p>
                  * needs_attention - <p class="mb-2">The transaction could not be completed because the connection with the gateway was terminated unexpectedly. For some gateways, Chargebee automatically reconciles such transactions. For others, you must manually reconcile them by using the <a href="/docs/api/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  Use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (gateway transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transactions.</p></div>
                  * late_failure - <p class="mb-2">A payment that was previously marked as successful has failed due to a late failure notification from the gateway. This can happen if the account had insufficient funds or was closed after the initial authorization.</p>
                  * voided - <p class="mb-2">The transaction was voided, or the authorization expired at the gateway.</p>
                  * failure - <p class="mb-2">The transaction failed. Refer to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">error_code</code>
                  and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">error_text</code>
                  fields for details about the failure.</p>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              txn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The time when the transaction occurred, in seconds since the Unix epoch.
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount of the transaction.
                minimum: 0
                example: null
              txn_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of transaction.</p>
                  * authorization - <p class="mb-2">The transaction is an authorization to capture the <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
                  from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
                  .</p>
                  * refund - <p class="mb-2">The transaction is a refund that returns the <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
                  to the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
                  .</p>
                  * payment - <p class="mb-2">The transaction is a payment that captures the <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
                  from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
                  .</p>
                  * payment_reversal - <p class="mb-2">The transaction is a reversal of a previously captured payment.</p>
                enum:
                - authorization
                - payment
                - refund
                - payment_reversal
                example: null
              amount_capturable:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |-
                  <p class="mb-2">This is the part of the authorized <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount</code>
                  that is yet to be captured. The payment capture is recorded as a transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
                  = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>.
                  Applicable only for a transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
                  = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">authorization</code>
                  .</p>
                minimum: 0
                example: null
              authorization_reason:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Type of reason for the authorization transaction.</p>
                  * verification - <p class="mb-2">The transaction was created to verify the payment method.</p>
                  * blocking_funds - <p class="mb-2">The transaction was created to block funds from the payment method.</p>
                  * scheduled_capture - <p class="mb-2">The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under <code><a href="">linked_payments</a></code>
                  .</p>
                enum:
                - verification
                - blocking_funds
                - scheduled_capture
                example: null
            required:
            - amount_capturable
            - applied_amount
            - applied_at
            - txn_id
            - txn_type
            example: null
          example: null
        dunning_attempts:
          type: array
          deprecated: false
          description: |
            The list of dunning_attempts for this invoice
          items:
            type: object
            deprecated: false
            properties:
              attempt:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Dunning attempt number.
                example: null
              transaction_id:
                type: string
                deprecated: false
                description: |
                  Transaction associated with attempt.
                maxLength: 40
                example: null
              dunning_type:
                type: string
                default: auto_collect
                deprecated: false
                description: |
                  Types of dunning
                  \* offline -

                  Dunning type is offline.
                  \* direct_debit -

                  Dunning type is direct debit.
                  \* auto_collect -

                  Dunning type is auto collection.
                enum:
                - auto_collect
                - offline
                - direct_debit
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp at which the attempt was made.
                example: null
              txn_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of this transaction.</p>
                  * success - <p class="mb-2">The transaction is successful.</p>
                  * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                  for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                  transaction to be reconciled at par with the gateway.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transaction status</p></div>
                  * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                  * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                  * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                  * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                  * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of the transaction
                minimum: 0
                example: null
              retry_engine:
                type: string
                default: chargebee
                deprecated: false
                description: |
                  The payment retry system used for this dunning attempt.
                  \* chargebee -

                  The attempt was processed by Chargebee Recovery.
                  \* success_plus -

                  The attempt was processed by GoCardless Success Plus.
                  \* flexpay -

                  The attempt was processed by FlexPay Recovery.
                enum:
                - chargebee
                - flexpay
                - successplus
                example: null
            required:
            - attempt
            - dunning_type
            example: null
          example: null
        applied_credits:
          type: array
          deprecated: false
          description: |
            Refundable Credits applied on this invoice.
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                description: |
                  Credit applied on the credit note ID.
                maxLength: 50
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total credit amount applied to this invoice.
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Time when the credit amount applied to this invoice.
                example: null
              cn_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead
                  \* other -

                  Can be set when none of the above reason codes are applicable
                  \* order_cancellation -

                  Order Cancellation
                  \* product_unsatisfactory -

                  Product Unsatisfactory
                  \* chargeback -

                  Can be set when you are recording your customer Chargebacks
                  \* subscription_cancellation -

                  This reason will be set automatically for Credit Notes created during cancel subscription operation
                  \* fraudulent -

                  FRAUDULENT
                  \* subscription_pause -

                  This reason will be automatically set to credit notes created during pause/resume subscription operation.
                  \* service_unsatisfactory -

                  Service Unsatisfactory
                  \* subscription_change -

                  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                  is enabled
                  \* write_off -

                  This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                  operation.
                  \* order_change -

                  Order Change
                  \* waiver -

                  Waiver
                enum:
                - write_off
                - subscription_change
                - subscription_cancellation
                - subscription_pause
                - chargeback
                - product_unsatisfactory
                - service_unsatisfactory
                - order_change
                - order_cancellation
                - waiver
                - other
                - fraudulent
                example: null
              cn_create_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code
                maxLength: 100
                example: null
              cn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the date at which this credit note is created
                example: null
              cn_status:
                type: string
                deprecated: false
                description: |
                  Credit note status.
                  \* voided -

                  When the Credit Note has been cancelled.
                  \* adjusted -

                  When the Credit Note has been adjusted against an invoice.
                  \* refund_due -

                  When the credits are yet to be used, or have been partially used.
                  \* refunded -

                  When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                enum:
                - adjusted
                - refunded
                - refund_due
                - voided
                example: null
              tax_application:
                type: string
                deprecated: false
                description: |
                  Specifies how tax is handled for credits applied to this invoice.
                  \* pre_tax -

                  Credits are applied before tax calculation.
                  \* post_tax -

                  Credits are applied after tax calculation.
                enum:
                - pre_tax
                - post_tax
                example: null
            required:
            - applied_amount
            - applied_at
            - cn_id
            - cn_status
            example: null
          example: null
        adjustment_credit_notes:
          type: array
          deprecated: false
          description: |
            Adjustments created for this invoice
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                description: |
                  Credit-note id
                maxLength: 50
                example: null
              cn_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead
                  \* subscription_cancellation -

                  This reason will be set automatically for Credit Notes created during cancel subscription operation
                  \* waiver -

                  Waiver
                  \* write_off -

                  This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                  operation.
                  \* service_unsatisfactory -

                  Service Unsatisfactory
                  \* fraudulent -

                  FRAUDULENT
                  \* product_unsatisfactory -

                  Product Unsatisfactory
                  \* order_change -

                  Order Change
                  \* subscription_change -

                  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                  is enabled
                  \* order_cancellation -

                  Order Cancellation
                  \* other -

                  Can be set when none of the above reason codes are applicable
                  \* chargeback -

                  Can be set when you are recording your customer Chargebacks
                  \* subscription_pause -

                  This reason will be automatically set to credit notes created during pause/resume subscription operation.
                enum:
                - write_off
                - subscription_change
                - subscription_cancellation
                - subscription_pause
                - chargeback
                - product_unsatisfactory
                - service_unsatisfactory
                - order_change
                - order_cancellation
                - waiver
                - other
                - fraudulent
                example: null
              cn_create_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code
                maxLength: 100
                example: null
              cn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the date at which this credit note is created
                example: null
              cn_total:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Total amount of the credit note.
                minimum: 0
                example: null
              cn_status:
                type: string
                deprecated: false
                description: |
                  Credit note status.
                  \* refunded -

                  When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                  \* voided -

                  When the Credit Note has been cancelled.
                  \* refund_due -

                  When the credits are yet to be used, or have been partially used.
                  \* adjusted -

                  When the Credit Note has been adjusted against an invoice.
                enum:
                - adjusted
                - refunded
                - refund_due
                - voided
                example: null
            required:
            - cn_id
            - cn_status
            example: null
          example: null
        issued_credit_notes:
          type: array
          deprecated: false
          description: |
            Credit notes issued for this invoice
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                description: |
                  Credit-note id
                maxLength: 50
                example: null
              cn_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead
                  \* fraudulent -

                  FRAUDULENT
                  \* chargeback -

                  Can be set when you are recording your customer Chargebacks
                  \* subscription_pause -

                  This reason will be automatically set to credit notes created during pause/resume subscription operation.
                  \* order_change -

                  Order Change
                  \* subscription_change -

                  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                  is enabled
                  \* product_unsatisfactory -

                  Product Unsatisfactory
                  \* write_off -

                  This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                  operation.
                  \* subscription_cancellation -

                  This reason will be set automatically for Credit Notes created during cancel subscription operation
                  \* service_unsatisfactory -

                  Service Unsatisfactory
                  \* waiver -

                  Waiver
                  \* order_cancellation -

                  Order Cancellation
                  \* other -

                  Can be set when none of the above reason codes are applicable
                enum:
                - write_off
                - subscription_change
                - subscription_cancellation
                - subscription_pause
                - chargeback
                - product_unsatisfactory
                - service_unsatisfactory
                - order_change
                - order_cancellation
                - waiver
                - other
                - fraudulent
                example: null
              cn_create_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code
                maxLength: 100
                example: null
              cn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the date at which this credit note is created
                example: null
              cn_total:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Total amount of the credit note.
                minimum: 0
                example: null
              cn_status:
                type: string
                deprecated: false
                description: |
                  Credit note status.
                  \* refund_due -

                  When the credits are yet to be used, or have been partially used.
                  \* adjusted -

                  When the Credit Note has been adjusted against an invoice.
                  \* voided -

                  When the Credit Note has been cancelled.
                  \* refunded -

                  When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                enum:
                - adjusted
                - refunded
                - refund_due
                - voided
                example: null
            required:
            - cn_id
            - cn_status
            example: null
          example: null
        linked_orders:
          type: array
          deprecated: false
          description: |
            The list of orders for this invoice
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the order. It is the api identifier for the order
                maxLength: 40
                example: null
              document_number:
                type: string
                deprecated: false
                description: |
                  The order's serial number
                maxLength: 50
                example: null
              status:
                type: string
                default: new
                deprecated: false
                description: |
                  The status of this order.
                  \* awaiting_shipment -

                  The order has been picked up by an integration system, and synced to a shipping management platform
                  \* queued -

                  Order is yet to be processed by any system, these are scheduled orders created by Chargebee
                  \* returned -

                  The order has been returned after delivery.
                  \* complete -

                  Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system
                  \* processing -

                  Order is being processed. Applicable only if you are using Chargebee's legacy order management system
                  \* new -

                  Order has been created. Applicable only if you are using Chargebee's legacy order management system.
                  \* shipped -

                  The order has moved from order management system to a shipping system.
                  \* on_hold -

                  The order is paused from being processed.
                  \* cancelled -

                  Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system
                  \* delivered -

                  The order has been delivered to the customer.
                  \* partially_delivered -

                  The order has been partially delivered to the customer.
                  \* voided -

                  Order has been voided. Applicable only if you are using Chargebee's legacy order management system
                enum:
                - new
                - processing
                - complete
                - cancelled
                - voided
                - queued
                - awaiting_shipment
                - on_hold
                - delivered
                - shipped
                - partially_delivered
                - returned
                example: null
              order_type:
                type: string
                deprecated: false
                description: |
                  Order type
                  \* system_generated -

                  The order has been created by Chargebee automatically based on the preferences set by the user.
                  \* manual -

                  The order has been created by the user using Chargebee's legacy order management system.
                enum:
                - manual
                - system_generated
                example: null
              reference_id:
                type: string
                deprecated: false
                description: |
                  Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.
                maxLength: 50
                example: null
              fulfillment_status:
                type: string
                deprecated: false
                description: |
                  The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;
                maxLength: 50
                example: null
              batch_id:
                type: string
                deprecated: false
                description: |
                  Unique id to identify a group of orders.
                maxLength: 50
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The time at which the order was created
                example: null
            required:
            - created_at
            - id
            example: null
          example: null
        notes:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">The list of <a href="https://www.chargebee.com/docs/2.0/invoice_notes.html">notes</a>
            that appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_type</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
            defined. There can be up to two notes in this array for which <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_type</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
            are not defined:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><strong class="font-semibold">Invoice-specific note:</strong> It is the note provided via the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_note</code> parameter for various endpoints in the API that also create invoices. For example, <a href="/docs/api/subscriptions/create-subscription-for-items#invoice_notes">creating a subscription</a>, <a href="/docs/api/invoices/create-invoice-for-items-and-one-time-charges">creating an invoice</a>, and <a href="/docs/api/invoices/close-a-pending-invoice#invoice_note">closing a pending invoice</a>.</li>
            <li class="text-base leading-relaxed"><strong class="font-semibold">General note:</strong> This note is added to all invoices of the Chargebee site. You can <a href="https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes" target="_blank">add/edit</a> this note in the Chargebee admin console.</li>
            </ul>
          items:
            type: object
            deprecated: false
            properties:
              note:
                type: string
                deprecated: false
                description: |
                  Actual note.
                maxLength: 65000
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  Unique identifier of the entity.
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Type of entity to which the note belongs.
                  \* subscription -

                  Entity that represents a subscription of customer.
                  \* customer -

                  Entity that represents a customer.
                  \* plan -

                  Entity that represents a plan.
                  \* tax -

                  The note is configured as part of the [tax configuration](https://www.chargebee.com/docs/tax.html)
                  in Chargebee Billing.
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* addon -

                  Entity that represents an addon.
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* coupon -

                  Entity that represents a coupon.
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                enum:
                - plan
                - addon
                - coupon
                - subscription
                - customer
                - plan_item_price
                - addon_item_price
                - charge_item_price
                - tax
                example: null
            required:
            - note
            example: null
          example: null
        shipping_address:
          type: object
          deprecated: false
          description: |
            Shipping address for the invoice.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* not_validated -

                Address is not yet validated.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for the invoice.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* not_validated -

                Address is not yet validated.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        statement_descriptor:
          type: object
          deprecated: false
          description: |
            Statement descriptor for the invoice.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Uniquely identifies a statement_descriptor
              maxLength: 40
              example: null
            descriptor:
              type: string
              deprecated: false
              description: |
                Payment descriptor text
              maxLength: 65000
              example: null
          required:
          - id
          example: null
        einvoice:
          type: object
          deprecated: false
          description: |
            An e-invoice or electronic invoice is a structured representation of an invoice that is interoperable between computerized invoicing systems. Depending on the country, e-invoicing can be necessary to meet financial/taxation authority regulations.
          properties:
            id:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                for the e-invoice. This is auto-generated by Chargebee.</p>
              maxLength: 50
              example: null
            reference_id:
              type: string
              deprecated: false
              description: |
                Identifier returned by the connected e-invoicing provider for this submission (for example, a document submission id). Chargebee uses this value when communicating with the provider to retrieve submission status and related artifacts.
              maxLength: 50
              example: null
            reference_number:
              type: string
              deprecated: false
              description: |
                This attribute is used to populate the unique reference number assigned to an invoice on the Invoice Registration Portal (IRP) network. It is essential for identifying and tracking invoices that are processed through the IRP network.

                In the future, this field may be used to store similar reference numbers for other networks.
              maxLength: 100
              example: null
            status:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                , see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code>
                .</p>
                * under_query - <p class="mb-2">The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.</p>
                * rejected - <p class="mb-2">The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.</p>
                * paid - <p class="mb-2">The receiving entity has confirmed that the e-invoice has been paid.</p>
                * skipped - <p class="mb-2">The e-invoice was not sent. This could be due to missing information or because the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>
                is not registered on the e-invoicing network.</p>
                * failed - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered.</p>
                * in_progress - <p class="mb-2">The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.</p>
                * message_acknowledgement - <p class="mb-2">An acknowledgment confirming that the application response was successfully received by the receiving entity.</p>
                * scheduled - <p class="mb-2">Sending the e-invoice to the customer has been scheduled.</p>
                * conditionally_accepted - <p class="mb-2">The e-invoice has been accepted with conditions.</p>
                * accepted - <p class="mb-2">The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.</p>
                * success - <p class="mb-2">The e-invoice has been successfully delivered to the customer.</p>
                * in_process - <p class="mb-2">The e-invoice is currently being processed by the receiving entity.</p>
                * registered - <p class="mb-2">The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.</p>
              enum:
              - scheduled
              - skipped
              - in_progress
              - success
              - failed
              - registered
              - accepted
              - rejected
              - message_acknowledgement
              - in_process
              - under_query
              - conditionally_accepted
              - paid
              example: null
            message:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">Detailed information about the status of the e-invoice. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">skipped</code>
                or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code>
                , this contains the reason or error details. The following are some valid examples:</p>
                <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">Invoice successfully sent to customer via the e-invoicing network 9090:123456</li>
                <li class="text-base leading-relaxed">Invoice successfully sent to customer via email id abc@acme.com</li>
                </ul>
              maxLength: 3000
              example: null
            provider_references:
              type: array
              deprecated: false
              items:
                example: null
              example: null
          required:
          - id
          - status
          example: null
        site_details_at_creation:
          type: object
          deprecated: false
          description: |
            It contains site-specific information, including timezone and organisational address.
          properties:
            timezone:
              type: string
              deprecated: false
              description: |
                It represents the timezone of the site at the time of entity creation.
              maxLength: 50
              example: null
            organization_address:
              type: object
              additionalProperties: true
              deprecated: false
              description: |
                It represents the address configured for the site during entity creation.
              example: null
          example: null
      required:
      - currency_code
      - customer_id
      - deleted
      - id
      - is_gifted
      - price_type
      - recurring
      - status
      - sub_total
      - tax
      - term_finalized
      example: null
    InvoiceDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    InvoiceDunningHandling:
      type: string
      deprecated: false
      enum:
      - continue
      - stop
      example: null
    InvoiceEstimate:
      type: object
      properties:
        recurring:
          type: boolean
          default: true
          deprecated: false
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        credits_applied:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        amount_paid:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        amount_due:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        round_off_amount:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        line_items:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                example: null
              pricing_model:
                type: string
                deprecated: false
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_tiers:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        line_item_credits:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              applied_amount:
                type: number
                format: double
                default: 0
                deprecated: false
                example: null
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
            required:
            - applied_amount
            - cn_id
            example: null
          example: null
        line_item_addresses:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              first_name:
                type: string
                deprecated: false
                maxLength: 150
                example: null
              last_name:
                type: string
                deprecated: false
                maxLength: 150
                example: null
              email:
                type: string
                format: email
                deprecated: false
                maxLength: 70
                example: null
              company:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              phone:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              line1:
                type: string
                deprecated: false
                maxLength: 150
                example: null
              line2:
                type: string
                deprecated: false
                maxLength: 150
                example: null
              line3:
                type: string
                deprecated: false
                maxLength: 150
                example: null
              city:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              state_code:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              state:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              country:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              zip:
                type: string
                deprecated: false
                maxLength: 20
                example: null
              validation_status:
                type: string
                default: not_validated
                deprecated: false
                enum:
                - not_validated
                - valid
                - partially_valid
                - invalid
                example: null
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
      required:
      - currency_code
      - price_type
      - recurring
      - sub_total
      example: null
    InvoiceGeneratedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    InvoiceGeneratedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    InvoiceUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemType:
      type: string
      deprecated: false
      enum:
      - plan
      - addon
      - charge
      example: null
    Layout:
      type: string
      deprecated: false
      enum:
      - in_app
      - full_page
      example: null
    Level:
      type: object
      description: |
        This resource returns the entitlement level attributes.
      properties:
        name:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">A case-sensitive display name for the entitlement level. Provide a name that helps you clearly identify the entitlement level. For example: a feature such as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Email Support</code>
            can have entitlement levels named as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">All weekdays</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">All days</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">40 hours per week</code>
            and so on.</p>
            <p class="mb-2">When not provided for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">feature.type</code>
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">range</code>
            , this name is auto-generated as the space-separated concatenation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].value</code>
            and the pluralized version of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit</code>.
            For example, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].value</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">20</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">user</code>
            , then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].name</code>
            becomes <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">20 users</code>
            .</p>
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The value denoting the entitlement level granted.</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><strong class="font-semibold">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code>:</strong> this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">number of users</code> can have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].value</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">5</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">20</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">50</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">100</code>. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].is_unlimited</code> is used to set the entitlement level to &quot;unlimited&quot;.</li>
            <li class="text-base leading-relaxed"><strong class="font-semibold">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">range</code>:</strong> there can be be only two elements in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[]</code> array; one corresponding to the minimum value (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[0]</code>) and the other to the maximum value (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[1]</code>) of the range of possible entitlement levels. For example, a feature such as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">number of users</code> may have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[0].value</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">5</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[1].value</code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">50000</code>. When the upper limit is &quot;unlimited&quot;, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[1].value</code> is not set and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[1].is_unlimited</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.</li>
            <li class="text-base leading-relaxed"><strong class="font-semibold">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">custom</code>:</strong> this attribute denotes the value of this custom entitlement level. For example, a feature <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Email Support</code> can have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].value</code> as one of say, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">24×7</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">24×5</code>.</li>
            </ul>
          maxLength: 50
          example: null
        level:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">This attribute represents the order of the entitlement levels from lowest to highest.</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">custom</code>: The lowest entitlement level has the value <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code>, the next higher level has the value <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">1</code>, followed by <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">2</code>, and so on.</li>
            <li class="text-base leading-relaxed">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">range</code>: This attribute is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">0</code> for the minimum value and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">1</code> for the maximum value in the range.</li>
            </ul>
            <p class="mb-2">When not defined, it is assumed as the index of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[]</code>
            array.</p>
          example: null
        is_unlimited:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">range</code>
            , this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>: The entitlement level corresponds to unlimited units of the feature. <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].value</code> is ignored for this level. This can only be set for the level that has the highest value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">levels[].level.</code></li>
            <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>: The entitlement level does not correspond to unlimited units of the feature.</li>
            </ul>
          example: null
      required:
      - is_unlimited
      - level
      - value
      example: null
    Meter:
      type: object
      properties:
        feature_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - simple
          - compound
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - active
          - archived
          - deleted
          example: null
        query:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        meter_strategy:
          type: string
          deprecated: false
          example: null
        feature_ids:
          type: array
          deprecated: false
          items:
            type: string
            deprecated: false
            maxLength: 50
            example: null
          example: null
        column_definitions:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              column_name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              property_data_type:
                type: string
                deprecated: false
                enum:
                - number
                - string
                example: null
              data_type:
                type: string
                deprecated: false
                enum:
                - number
                - string
                example: null
            required:
            - column_name
            - data_type
            - property_data_type
            example: null
          example: null
        features:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              name:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 500
                example: null
              status:
                type: string
                deprecated: false
                enum:
                - active
                - archived
                - draft
                example: null
              type:
                type: string
                deprecated: false
                enum:
                - switch
                - custom
                - quantity
                - range
                example: null
              unit:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              levels:
                type: array
                deprecated: false
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    value:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    level:
                      type: integer
                      format: int32
                      deprecated: false
                      example: null
                    is_unlimited:
                      type: boolean
                      deprecated: false
                      example: null
                  required:
                  - is_unlimited
                  - level
                  - value
                  example: null
                example: null
            required:
            - created_at
            - id
            - name
            example: null
          example: null
      required:
      - feature_id
      - id
      - name
      - query
      - type
      example: null
    MeteredFeature:
      type: object
      properties:
        meter_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        column_definitions:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              column_name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              property_data_type:
                type: string
                deprecated: false
                enum:
                - number
                - string
                example: null
              data_type:
                type: string
                deprecated: false
                enum:
                - number
                - string
                example: null
            required:
            - column_name
            - data_type
            - property_data_type
            example: null
          example: null
      required:
      - feature_id
      - meter_id
      example: null
    Mode:
      type: string
      deprecated: false
      enum:
      - absolute
      - percentage
      example: null
    MrrUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
          required:
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    NetdPaymentDueReminderEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    NonSubscription:
      type: object
      description: |
        **Important:**
        These APIs operate asynchronously. When you receive a successful response code from an API call, it indicates only the successful submission of your request, not the completion of the operation.

        Using the Non-Subscription resource, you can track one-time payments made for consumable, non-consumable, and non-renewing products in Chargebee. Call this API to notify Chargebee of non-subscription purchases made at stores.
      properties:
        invoice_id:
          type: string
          deprecated: false
          description: |
            The unique immutable identifier of the invoice imported in Chargebee for which the receipt was sent.
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The unique immutable identifier of the customer object to which the invoice belongs.
          maxLength: 100
          example: null
        charge_id:
          type: string
          deprecated: false
          description: <p class="mb-2">The <code class="bg-gray-100 text-gray-800
            font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm
            font-mono whitespace-nowrap">id</code> of the non-recurring add-on.</p>
          maxLength: 100
          example: null
      required:
      - charge_id
      - invoice_id
      example: null
    NotifyReferralSystem:
      type: string
      deprecated: false
      enum:
      - none
      - first_paid_conversion
      - all_invoices
      example: null
    OfferEvent:
      type: object
      description: |
        Offer events are used to record and list user interactions with personalized offers. By logging events such as views and dismissals, these APIs enable growth and analytics teams to measure the effectiveness of offers and optimize the offer funnel based on real usage data.
      example: null
    OfferFulfillment:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">Offer fulfillment allows you to initiate, update, and retrieve the lifecycle of an offer fulfillment, after a personalized offer has been accepted. Whether the personalized offer triggers a direct billing change, a hosted checkout flow, or a redirect-based workflow, these APIs track acceptance, execution status, and completion, providing a consistent interface for fulfillment tracking and notifications.</p><p class="mb-2"><strong class="font-semibold">Features of this object:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Records fulfillment IDs for tracking and reference.</li>
        <li class="text-base leading-relaxed">Captures status (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_progress</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">completed</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">failed</code>).</li>
        <li class="text-base leading-relaxed">Stores redirect/checkout URLs as needed.</li>
        <li class="text-base leading-relaxed">Contains timestamps for creation, completion, or failure.</li>
        <li class="text-base leading-relaxed">Includes error codes and messages for failure analysis.</li>
        </ul></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            ID of the fulfillment that was created.
          maxLength: 50
          example: null
        personalized_offer_id:
          type: string
          deprecated: false
          description: |
            ID of the personalized offer that was accepted.
          maxLength: 50
          example: null
        option_id:
          type: string
          deprecated: false
          description: |
            ID of the offer option that was selected by the user.
          maxLength: 50
          example: null
        processing_type:
          type: string
          deprecated: false
          description: |
            The processing mode of the option. This indicates how the offer option is fulfilled: e.g., a direct billing change, a checkout flow, or a redirect to a URL.
            \* webhook -

            Chargebee triggers webhook and fulfillment is processed by merchant's system
            \* email -

            Chargebee sends an email as configured in the Growth application and the fulfillment is processed by merchant's system
            \* checkout -

            The offer fulfillment is processed using Chargebee hosted checkout
            \* url_redirect -

            The offer fulfillment is processed by merchant's system
            \* billing_update -

            The offer fulfillment is processed by Chargebee
          enum:
          - billing_update
          - checkout
          - url_redirect
          - webhook
          - email
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Current status of the offer fulfillment process.</p>
            * in_progress - <p class="mb-2">The offer fulfillment is underway (not yet completed).</p>
            * completed - <p class="mb-2">The offer was successfully applied . For URL redirects, this might be returned immediately if the action is completed, potentially along with a redirect_url if the user should be navigated to a specific page.</p>
            * failed - <p class="mb-2">The offer fulfillment failed. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">error object</code>
            field will be present to provide more details in this case.</p>
          enum:
          - in_progress
          - completed
          - failed
          example: null
        redirect_url:
          type: string
          deprecated: false
          description: |
            A URL to which the user should be redirected. Returned only if the offer's processing type is billing_update or url_redirect
          maxLength: 250
          example: null
        failed_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the fulfillment failed (present only when status = failed).
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the fulfillment record was created.
          example: null
        completed_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the fulfillment succeeded (present only when status = completed).
          example: null
        error:
          type: object
          deprecated: false
          description: |
            Error details describing the reason for failure (present only if status is failed).
          properties:
            code:
              type: string
              deprecated: false
              description: |
                A Chargebee-defined code that corresponds to the specific error encountered during the fulfillment.
                \* fulfillment_expired -

                Returned when the fulfillment has been in progress for more than 7 days, resulting in the system automatically marking it as failed.
                \* internal_error -

                Returned when a system error occurred during fulfillment via checkout or billing updates.
                \* external_fulfillment_failed -

                Returned when the fulfillment is marked as failed by the merchant, particularly in cases involving URL redirects, webhooks, and email processing types.
                \* billing_update_failed -

                Returned when Chargebee is unable to fulfill the offer while updating the Chargebee billing subscription.
                \* checkout_abandoned -

                Returned when the checkout process was abandoned by the user.
              enum:
              - billing_update_failed
              - checkout_abandoned
              - external_fulfillment_failed
              - internal_error
              - fulfillment_expired
              example: null
            message:
              type: string
              deprecated: false
              description: |
                A descriptive message about the error. This is intended for developer (or merchant) consumption and should not be displayed directly to end customers.
              maxLength: 200
              example: null
          required:
          - code
          - message
          example: null
      required:
      - created_at
      - id
      - option_id
      - personalized_offer_id
      - processing_type
      - status
      example: null
    OfflinePaymentMethod:
      type: string
      deprecated: false
      enum:
      - no_preference
      - cash
      - check
      - bank_transfer
      - ach_credit
      - sepa_credit
      - boleto
      - us_automated_bank_transfer
      - eu_automated_bank_transfer
      - uk_automated_bank_transfer
      - jp_automated_bank_transfer
      - mx_automated_bank_transfer
      - custom
      example: null
    OmnichannelSubscriptionItemOffer:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        offer_id_at_source:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        category:
          type: string
          deprecated: false
          enum:
          - introductory
          - promotional
          - developer_determined
          example: null
        category_at_source:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - free_trial
          - pay_up_front
          - pay_as_you_go
          example: null
        type_at_source:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        discount_type:
          type: string
          deprecated: false
          enum:
          - fixed_amount
          - percentage
          - price
          example: null
        duration:
          type: string
          deprecated: false
          maxLength: 5
          example: null
        percentage:
          type: number
          format: double
          deprecated: false
          maximum: 100
          minimum: 0.01
          example: null
        price_currency:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        price_units:
          type: integer
          format: int64
          deprecated: false
          example: null
        price_nanos:
          type: integer
          format: int64
          deprecated: false
          example: null
        offer_term_start:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        offer_term_end:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          example: null
      required:
      - category
      - duration
      - id
      - type
      example: null
    OnEvent:
      type: string
      deprecated: false
      enum:
      - subscription_creation
      - subscription_trial_start
      - plan_activation
      - subscription_activation
      - contract_termination
      example: null
    Operation:
      type: string
      deprecated: false
      enum:
      - create
      - update
      - delete
      example: null
    Order:
      type: object
      description: |
        **Note:**
        This doc is for the latest version of Chargebee Orders. If you enabled Chargebee Orders before *September-30-2018*
        , you may be using the legacy version of the feature and its API. For help in migrating to the current system or using the legacy API for Chargebee Orders, please [contact support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)

        Orders are automatically generated for an invoice when it gets paid, based on the shipping preference chosen for the invoice's product and the shipping date configuration. They can be updated either via api or merchant web console (a.k.a admin console).
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies the order. It is the api identifier for the order
          maxLength: 40
          example: null
        document_number:
          type: string
          deprecated: false
          description: |
            The order's serial number
          maxLength: 50
          example: null
        invoice_id:
          type: string
          deprecated: false
          description: |
            The invoice number which acts as an identifier for invoice and is generated sequentially.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The subscription for which the order is created
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The customer for which the order is created
          maxLength: 50
          example: null
        status:
          type: string
          default: new
          deprecated: false
          description: |
            The status of this order.
            \* complete -

            Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system
            \* partially_delivered -

            The order has been partially delivered to the customer.
            \* voided -

            Order has been voided. Applicable only if you are using Chargebee's legacy order management system
            \* on_hold -

            The order is paused from being processed.
            \* awaiting_shipment -

            The order has been picked up by an integration system, and synced to a shipping management platform
            \* shipped -

            The order has moved from order management system to a shipping system.
            \* queued -

            Order is yet to be processed by any system, these are scheduled orders created by Chargebee
            \* new -

            Order has been created. Applicable only if you are using Chargebee's legacy order management system.
            \* returned -

            The order has been returned after delivery.
            \* delivered -

            The order has been delivered to the customer.
            \* cancelled -

            Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system
            \* processing -

            Order is being processed. Applicable only if you are using Chargebee's legacy order management system
          enum:
          - new
          - processing
          - complete
          - cancelled
          - voided
          - queued
          - awaiting_shipment
          - on_hold
          - delivered
          - shipped
          - partially_delivered
          - returned
          example: null
        cancellation_reason:
          type: string
          deprecated: false
          description: |
            Cancellation reason
            \* payment_declined -

            Payment declined.
            \* shipping_cut_off_passed -

            The invoice has been paid late and Chargebee cancel's the first order for the invoice.
            \* product_not_available -

            Product not available.
            \* alternative_found -

            Alternative found.
            \* others -

            Other reason
            \* order_resent -

            Order resent
            \* product_unsatisfactory -

            Product unsatisfactory.
            \* delivery_date_missed -

            Delivery date missed.
            \* fraudulent_transaction -

            Fraudulent transaction.
            \* invoice_voided -

            The invoice for which the order was createed has been voided.
            \* subscription_cancelled -

            The subsctiption for which the order was created has been cancelled.
            \* invoice_written_off -

            The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.
            \* product_not_required -

            Product not required.
            \* third_party_cancellation -

            Third party cancellation.
          enum:
          - shipping_cut_off_passed
          - product_unsatisfactory
          - third_party_cancellation
          - product_not_required
          - delivery_date_missed
          - alternative_found
          - invoice_written_off
          - invoice_voided
          - fraudulent_transaction
          - payment_declined
          - subscription_cancelled
          - product_not_available
          - others
          - order_resent
          example: null
        payment_status:
          type: string
          deprecated: false
          description: |
            The payment status of the order
            \* paid -

            PAID
            \* not_paid -

            NOT_PAID
          enum:
          - not_paid
          - paid
          example: null
        order_type:
          type: string
          deprecated: false
          description: |
            Order type
            \* manual -

            The order has been created by the user using Chargebee's legacy order management system.
            \* system_generated -

            The order has been created by Chargebee automatically based on the preferences set by the user.
          enum:
          - manual
          - system_generated
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          description: |
            The price type of the order
            \* tax_inclusive -

            All amounts in the document are inclusive of tax.
            \* tax_exclusive -

            All amounts in the document are exclusive of tax.
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.
          maxLength: 50
          example: null
        fulfillment_status:
          type: string
          deprecated: false
          description: |
            The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;
          maxLength: 50
          example: null
        order_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date on which the order will start getting processed.
          example: null
        shipping_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            This is the date on which the order will be delivered to the customer.
          example: null
        note:
          type: string
          deprecated: false
          description: |
            The custom note for the order.
          maxLength: 600
          example: null
        tracking_id:
          type: string
          deprecated: false
          description: |
            The tracking id of the order.
          maxLength: 50
          example: null
        tracking_url:
          type: string
          deprecated: false
          description: |
            The tracking url of the order.
          maxLength: 255
          example: null
        batch_id:
          type: string
          deprecated: false
          description: |
            Unique id to identify a group of orders.
          maxLength: 50
          example: null
        created_by:
          type: string
          deprecated: false
          description: |
            The source (or the user) from where the order has been created.
          maxLength: 50
          example: null
        shipment_carrier:
          type: string
          deprecated: false
          description: |
            Shipment carrier
          maxLength: 50
          example: null
        invoice_round_off_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total round off taken from the invoice level
          minimum: 0
          example: null
        tax:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total tax for the order.
          minimum: 0
          example: null
        amount_paid:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total amount paid for the order.
          minimum: 0
          example: null
        amount_adjusted:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total amount adjusted for the order.
          minimum: 0
          example: null
        refundable_credits_issued:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total amount issued as credits on behalf of this order.
          minimum: 0
          example: null
        refundable_credits:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total amount that can be issued as credits for this order.
          minimum: 0
          example: null
        rounding_adjustement:
          type: integer
          format: int64
          deprecated: false
          description: |
            Rounding adjustment
          example: null
        paid_on:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The timestamp indicating the date \& time the order's invoice got paid.
          example: null
        shipping_cut_off_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time after which an order becomes unservicable
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the order was created
          example: null
        status_update_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the order status was last updated.
          example: null
        delivered_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the order was delivered
          example: null
        shipped_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the order was shipped.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The order's last modified time.
          example: null
        cancelled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the order was cancelled.
          example: null
        resent_status:
          type: string
          deprecated: false
          description: |
            Resent status of the order.
            \* fully_resent -

            Order is Fully resent
            \* partially_resent -

            Order is Partially resent
          enum:
          - fully_resent
          - partially_resent
          example: null
        is_resent:
          type: boolean
          default: false
          deprecated: false
          description: |
            Show if the order is resent order or not.
          example: null
        original_order_id:
          type: string
          deprecated: false
          description: |
            Refers to the original order id of the resent order.
          maxLength: 40
          example: null
        discount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total discount given for the order.
          minimum: 0
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          description: |
            The order's sub-total
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total amount charged for the order.
          minimum: 0
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the invoice
          maxLength: 3
          example: null
        is_gifted:
          type: boolean
          default: false
          deprecated: false
          description: |
            Boolean indicating whether this order is gifted or not.
          example: null
        gift_note:
          type: string
          deprecated: false
          description: |
            The gift message added by the gifter during purchase
          maxLength: 500
          example: null
        gift_id:
          type: string
          deprecated: false
          description: |
            The gift_id if the order is a gift order
          maxLength: 50
          example: null
        resend_reason:
          type: string
          deprecated: false
          description: |
            Reason code for resending the order. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Orders \> Order Resend**.
            Must be passed if set as mandatory in the app. The codes are case-sensitive
          maxLength: 100
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        order_line_items:
          type: array
          deprecated: false
          description: |
            The list of line items for this order.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  The identifier for the order line item.
                maxLength: 40
                example: null
              invoice_id:
                type: string
                deprecated: false
                description: |
                  The invoice of the line item.
                maxLength: 50
                example: null
              invoice_line_item_id:
                type: string
                deprecated: false
                description: |
                  The invoice line item id associated with this order line item.
                maxLength: 40
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The unit price.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  The line item description.
                maxLength: 250
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The sub total, of the order line item
                minimum: 0
                example: null
              fulfillment_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity that is going to get fulfilled for this order
                minimum: 0
                example: null
              fulfillment_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount that is going to get fulfilled for this order(amount after tax and discount)
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total tax applied on this line item
                minimum: 0
                example: null
              amount_paid:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount paid on the invoice, on behalf of this delivery
                minimum: 0
                example: null
              amount_adjusted:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount adjusted on the invoice, on behalf of this delivery
                minimum: 0
                example: null
              refundable_credits_issued:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total refundable credits issued on the invoice, on behalf of this delivery
                minimum: 0
                example: null
              refundable_credits:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount issued as credits on behalf of this delivery
                minimum: 0
                example: null
              is_shippable:
                type: boolean
                deprecated: false
                description: |
                  Appliable only if configured to include non shippable charges in orders, specifies if the charge is applicable for shipping
                example: null
              sku:
                type: string
                deprecated: false
                description: |
                  The SKU for the delivery.
                maxLength: 250
                example: null
              status:
                type: string
                default: queued
                deprecated: false
                description: |
                  The status of this order.
                  \* shipped -

                  The order line item has been shipped.
                  \* on_hold -

                  The delivery has been moved to "On hold" status.
                  \* cancelled -

                  The order has been returned after delivery.
                  \* returned -

                  The order has been returned after delivery.
                  \* partially_delivered -

                  The order has been partially delivered to the customer.
                  \* delivered -

                  The order line item has been delivered.
                  \* queued -

                  Not processed for shipping yet.
                  \* awaiting_shipment -

                  Moved to shipping platform.
                enum:
                - queued
                - awaiting_shipment
                - on_hold
                - delivered
                - shipped
                - partially_delivered
                - returned
                - cancelled
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity ([plan](/docs/api/v2/pcv-1/plans/plan-object)
                  / [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  etc) this line item is based on
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Item level discount amount
                minimum: 0
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The discount given on the order line item.
                minimum: 0
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this lineitem is based on. Will be null for 'adhoc' entity type
                maxLength: 50
                example: null
            required:
            - entity_type
            - id
            - invoice_id
            - invoice_line_item_id
            - is_shippable
            example: null
          example: null
        shipping_address:
          type: object
          deprecated: false
          description: |
            Shipping address for the order.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* not_validated -

                Address is not yet validated.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for the order.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
                \* not_validated -

                Address is not yet validated.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied on the order line items.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the tax is applicable
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The rate of tax used to calculate tax amount
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period end of the tax rate for the line item.
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period start of the tax rate for the line item.
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Indicates the prorated line item amount in cents.
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                description: |
                  Indicates if tax is applied only on a portion of the line item amount.
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                description: |
                  Indicates the non-compliance tax that should not be reported to the jurisdiction.
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Indicates the actual portion of the line item amount that is taxable.
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                description: |
                  The type of tax jurisdiction
                  \* federal -

                  The tax jurisdiction is a federal
                  \* state -

                  The tax jurisdiction is a state
                  \* county -

                  The tax jurisdiction is a county
                  \* country -

                  The tax jurisdiction is a country
                  \* city -

                  The tax jurisdiction is a city
                  \* special -

                  Special tax jurisdiction.
                  \* unincorporated -

                  Combined tax of state and county.
                  \* other -

                  Jurisdictions other than the ones listed above.
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax jurisdiction
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                description: |
                  The tax jurisdiction code
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          description: |
            The list of discounts applied for the order
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the discount is applicable.
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Type of this discount line item</p>
                  * prorated_credits - <p class="mb-2">Represents the credit adjustment items in invoice. The &#x27;coupon_id&#x27; attribute will be null in this case</p>
                  * document_level_coupon - <p class="mb-2">Represents the &#x27;Document&#x27; level coupons applied to this document. Further the &#x27;coupon_id&#x27; attribute specifies the <a href="/docs/api/coupons/coupon-object" target="_blank">coupon</a>
                  id this discount is based on</p>
                  * custom_discount - <p class="mb-2">Represents the discount applied on an resent order against the orginal order.</p>
                  * promotional_credits - <p class="mb-2">Represents the Promotional Credits item in invoice. The &#x27;coupon_id&#x27; attribute will be null in this case</p>
                  * item_level_coupon - <p class="mb-2">Represents the &#x27;Item&#x27; level coupons applied to this invoice. Further the &#x27;coupon_id&#x27; attribute specifies the <a href="/docs/api/coupons/coupon-object" target="_blank">coupon</a>
                  id this discount is based on</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a discount applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount id is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_discount - <p class="mb-2">The deduction is due to a discount applied to a line item of the invoice. The discount id is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - custom_discount
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Discount amount.
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        linked_credit_notes:
          type: array
          deprecated: false
          description: |
            The credit notes linked to the order
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount issued for this order
                minimum: 0
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)
                  about credit note types.
                  \* store -

                  Store Credit Note
                  \* refundable -

                  Refundable Credit Note
                  \* adjustment -

                  Adjustment Credit Note
                enum:
                - adjustment
                - refundable
                - store
                example: null
              id:
                type: string
                deprecated: false
                description: |
                  Credit-note id.
                maxLength: 50
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  The credit note status.
                  \* voided -

                  When the Credit Note has been cancelled.
                  \* refunded -

                  When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                  \* adjusted -

                  When the Credit Note has been adjusted against an invoice.
                  \* refund_due -

                  When the credits are yet to be used, or have been partially used.
                enum:
                - adjusted
                - refunded
                - refund_due
                - voided
                example: null
              amount_adjusted:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount adjusted on the order for the linked credit note. Applicable if the linked credit note is of the type 'adjustement'
                minimum: 0
                example: null
              amount_refunded:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total refundable credits issued on the order for the linked credit note. Applicable if the linked credit note is of the type 'refundable'
                minimum: 0
                example: null
            required:
            - id
            - status
            - type
            example: null
          example: null
        resent_orders:
          type: array
          deprecated: false
          description: |
            The list of resent orders applied on the order.
          items:
            type: object
            deprecated: false
            properties:
              order_id:
                type: string
                deprecated: false
                description: |
                  The order which is linked.
                maxLength: 40
                example: null
              reason:
                type: string
                deprecated: false
                description: |
                  The order resent reason.
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Value of the resent order.
                minimum: 0
                example: null
            required:
            - order_id
            example: null
          example: null
      required:
      - created_at
      - deleted
      - id
      - is_resent
      - price_type
      example: null
    OrderCancelledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderDeliveredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderReadyToProcessEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderReadyToShipEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderResentEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderReturnedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OrderUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            order:
              $ref: "#/components/schemas/Order"
          required:
          - order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PauseOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - end_of_term
      - specific_date
      - billing_cycles
      example: null
    PaymentFailedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
            invoice:
              $ref: "#/components/schemas/Invoice"
            customer:
              $ref: "#/components/schemas/Customer"
            subscription:
              $ref: "#/components/schemas/Subscription"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          - invoice
          - subscription
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentInitiatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
            invoice:
              $ref: "#/components/schemas/Invoice"
            customer:
              $ref: "#/components/schemas/Customer"
            subscription:
              $ref: "#/components/schemas/Subscription"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          - invoice
          - subscription
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentInitiator:
      type: string
      deprecated: false
      enum:
      - customer
      - merchant
      example: null
    PaymentIntent:
      type: object
      description: "<div class=\"api-description\"><p class=\"mb-2\">A <code class=\"\
        bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5\
        \ py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">payment_intent</code>\
        \ is created to help you navigate the 3DS flow of collecting payment from\
        \ your customer. It is necessary only for implementing 3DS flow using Chargebee.js.</p><h4>Auto-expiry</h4><p\
        \ class=\"mb-2\">All <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >payment_intent</code>s with <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >status</code> as <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >inited</code>, <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >in_progress</code> or <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >authorized</code> become <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >expired</code> after an <strong class=\"font-semibold\">hour</strong> automatically.</p></div>"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Identifier for PaymentIntent.
          maxLength: 150
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of PaymentIntent.
            \* in_progress -

            Status will be in_progress if the Active Payment Attempt state is in requires_identification, requires_challenge or requires_redirection.
            \* inited -

            Intent is initialized.
            \* authorized -

            3DS verification successfully completed.
            \* consumed -

            If any Chargebee operation such as create subscription etc. is completed using the intent, it will be in consumed state. Intent cannot be used if it's already in consumed state.
            \* expired -

            Intent has expired, since it was not consumed before the predefined time-out.
          enum:
          - inited
          - in_progress
          - authorized
          - consumed
          - expired
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the amount used in transaction.
          maxLength: 3
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount(in cents) to be authorized for 3DS flow.
          minimum: 0
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account used for performing the 3DS flow.
          maxLength: 50
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the PaymentIntent will expire if left unconsumed.
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
          maxLength: 200
          example: null
        payment_method_type:
          type: string
          default: card
          deprecated: false
          description: |
            The payment method of this intent
            \* apple_pay -

            apple_pay
            \* bancontact -

            bancontact
            \* netbanking_emandates -

            netbanking_emandates
            \* trustly -

            Trustly
            \* venmo -

            Venmo
            \* after_pay -

            Payments made via Afterpay
            \* giropay -

            giropay
            \* kakao_pay -

            Payments made via Kakao Pay.
            \* paypal_express_checkout -

            paypal_express_checkout
            \* boleto -

            boleto
            \* pix -

            Pix
            \* revolut_pay -

            Payments made via Revolut Pay.
            \* naver_pay -

            Payments made via Naver Pay.
            \* amazon_payments -

            amazon_payments
            \* electronic_payment_standard -

            Electronic Payment Standard
            \* grab_pay -

            Payments made via GrabPay
            \* card -

            card
            \* pay_by_bank -

            Pay By Bank
            \* go_pay -

            Payments made via GoPay
            \* payme -

            Payments made via PayMe
            \* google_pay -

            google_pay
            \* pay_co -

            Payments made via PayCo
            \* cash_app_pay -

            Payments made via Cash App Pay.
            \* ideal -

            ideal
            \* pay_to -

            PayTo
            \* alipay -

            Payments made via Alipay.
            \* dotpay -

            dotpay
            \* sofort -

            sofort
            \* sepa_instant_transfer -

            SEPA Instant Transfer
            \* direct_debit -

            direct_debit
            \* faster_payments -

            Faster Payments
            \* klarna_pay_now -

            Klarna Pay Now
            \* stablecoin -

            Payments made via Stablecoin.
            \* upi -

            upi
            \* swish -

            Payments made via Swish
            \* payconiq_by_bancontact -

            Payments made via Payconiq by Bancontact.
            \* twint -

            Payments made via Twint
            \* wechat_pay -

            Payments made via WeChat Pay.
            \* kbc_payment_button -

            KBC Payment Button
          enum:
          - card
          - ideal
          - sofort
          - bancontact
          - google_pay
          - dotpay
          - giropay
          - apple_pay
          - upi
          - netbanking_emandates
          - paypal_express_checkout
          - direct_debit
          - boleto
          - venmo
          - amazon_payments
          - pay_to
          - faster_payments
          - sepa_instant_transfer
          - klarna_pay_now
          - online_banking_poland
          - payconiq_by_bancontact
          - electronic_payment_standard
          - kbc_payment_button
          - pay_by_bank
          - trustly
          - stablecoin
          - kakao_pay
          - naver_pay
          - revolut_pay
          - cash_app_pay
          - wechat_pay
          - alipay
          - twint
          - go_pay
          - grab_pay
          - pay_co
          - after_pay
          - swish
          - payme
          - pix
          - klarna
          example: null
        success_url:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The URL the customer will be directed to once 3DS verification is successful. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
            .</p>
          maxLength: 250
          example: null
        failure_url:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The URL the customer will be directed to when 3DS verification fails. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_method_type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ideal</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sofort</code>
            , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">dotpay</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">giropay</code>
            .</p>
          maxLength: 250
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the PaymentIntent was created.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the PaymentIntent was last modified.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this payment intent was last updated.
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The unique identifier of the customer for whom the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> will be created. If specified, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> will be used exclusively for that customer. If not specified, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> won&#x27;t be associated with any customer and will be available for any customer.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">See also</strong></p><a href="/docs/api/payment_intents">Customer resource lookup and creation</a></div>
          maxLength: 50
          example: null
        gateway:
          type: string
          deprecated: false
          description: |
            Gateway associated with the PaymentIntent.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        active_payment_attempt:
          type: object
          deprecated: false
          description: |
            Active payment attempt for the PaymentIntent.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Identifier for PaymentIntent's active payment attempt.
              maxLength: 70
              example: null
            status:
              type: string
              deprecated: false
              description: |
                Current status of active payment attempt
                \* authorized -

                3DS verification successfully completed.
                \* requires_challenge -

                The transaction has to go through 3DS Challenge flow and the customer needs to authenticate via 3DS 2.0
                \* pending_authorization -

                Waiting for the authorization.
                \* inited -

                Payment attempt is initialized.
                \* requires_identification -

                Customer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.
                \* requires_redirection -

                The transaction has to go through 3DS Redirection flow and the customer needs to authenticate via 3DS 1.0
                \* refused -

                3DS verification attempt failed.
              enum:
              - inited
              - requires_identification
              - requires_challenge
              - requires_redirection
              - authorized
              - refused
              - pending_authorization
              example: null
            payment_method_type:
              type: string
              default: card
              deprecated: false
              description: |
                The payment method of this attempt
                \* venmo -

                Venmo
                \* sofort -

                sofort
                \* paypal_express_checkout -

                paypal_express_checkout
                \* giropay -

                giropay
                \* trustly -

                Trustly
                \* bancontact -

                bancontact
                \* card -

                card
                \* faster_payments -

                Faster Payments
                \* upi -

                upi
                \* amazon_payments -

                amazon_payments
                \* direct_debit -

                direct_debit
                \* dotpay -

                dotpay
                \* kbc_payment_button -

                KBC Payment Button
                \* apple_pay -

                apple_pay
                \* netbanking_emandates -

                netbanking_emandates
                \* ideal -

                ideal
                \* sepa_instant_transfer -

                SEPA Instant Transfer
                \* klarna_pay_now -

                Klarna Pay Now
                \* google_pay -

                google_pay
                \* pay_by_bank -

                Pay By Bank
                \* electronic_payment_standard -

                Electronic Payment Standard
                \* boleto -

                boleto
                \* pay_to -

                PayTo
              enum:
              - card
              - ideal
              - sofort
              - bancontact
              - google_pay
              - dotpay
              - giropay
              - apple_pay
              - upi
              - netbanking_emandates
              - paypal_express_checkout
              - direct_debit
              - boleto
              - venmo
              - amazon_payments
              - pay_to
              - faster_payments
              - sepa_instant_transfer
              - klarna_pay_now
              - online_banking_poland
              - payconiq_by_bancontact
              - electronic_payment_standard
              - kbc_payment_button
              - pay_by_bank
              - trustly
              - stablecoin
              - kakao_pay
              - naver_pay
              - revolut_pay
              - cash_app_pay
              - wechat_pay
              - alipay
              - twint
              - go_pay
              - grab_pay
              - pay_co
              - after_pay
              - swish
              - payme
              - pix
              - klarna
              example: null
            id_at_gateway:
              type: string
              deprecated: false
              description: |
                Reference of PaymentIntent at gateway
              maxLength: 50
              example: null
            error_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">Error code received from the payment gateway when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_attempt</code>
                fails.</p>
              maxLength: 100
              example: null
            error_text:
              type: string
              deprecated: false
              description: |
                Error message received from the payment gateway on failure.
              maxLength: 65000
              example: null
            checkout_details:
              type: string
              deprecated: false
              description: |
                JSON-encoded object that includes customer and browser details collected during checkout.
              maxLength: 65000
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp indicating when the active payment attempt was created.
              example: null
            modified_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp indicating when the active payment attempt was last modified.
              example: null
            error_detail:
              type: object
              deprecated: false
              description: |
                Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about \[gateway error references\](/docs/api/v2/pcv-1/gateway_error_references)
              properties:
                request_id:
                  type: string
                  deprecated: false
                  description: |
                    This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
                  maxLength: 100
                  example: null
                error_category:
                  type: string
                  deprecated: false
                  description: |
                    This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
                  maxLength: 100
                  example: null
                error_code:
                  type: string
                  deprecated: false
                  description: |
                    A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
                  maxLength: 100
                  example: null
                error_message:
                  type: string
                  deprecated: false
                  description: |
                    A message provided by the gateway that describes the nature of the error encountered
                  maxLength: 65000
                  example: null
                decline_code:
                  type: string
                  deprecated: false
                  description: |
                    When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
                  maxLength: 100
                  example: null
                decline_message:
                  type: string
                  deprecated: false
                  description: |
                    This message gives a descriptive explanation of the reason for the transaction's decline
                  maxLength: 65000
                  example: null
                network_error_code:
                  type: string
                  deprecated: false
                  description: |
                    This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
                  maxLength: 100
                  example: null
                network_error_message:
                  type: string
                  deprecated: false
                  description: |
                    This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered
                  maxLength: 65000
                  example: null
                error_field:
                  type: string
                  deprecated: false
                  description: |
                    This parameter indicates which specific data field or attribute in the request caused the error
                  maxLength: 100
                  example: null
                recommendation_code:
                  type: string
                  deprecated: false
                  description: |
                    After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
                  maxLength: 100
                  example: null
                recommendation_message:
                  type: string
                  deprecated: false
                  description: |
                    This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
                  maxLength: 65000
                  example: null
                processor_error_code:
                  type: string
                  deprecated: false
                  description: |
                    This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
                  maxLength: 100
                  example: null
                processor_error_message:
                  type: string
                  deprecated: false
                  description: |
                    This message describes the specific error that the payment processor encountered
                  maxLength: 65000
                  example: null
                error_cause_id:
                  type: string
                  deprecated: false
                  description: |
                    A [Chargebee-defined code](/docs/api/errors)
                    that corresponds to the specific error encountered during the request. This code helps in identifying and standardizing the error across different gateway services for consistent error handling.
                  maxLength: 150
                  example: null
                processor_advice_code:
                  type: string
                  deprecated: false
                  description: |
                    Advice code returned by the payment gateway or processor that provides guidance on how to handle a declined transaction, for example, whether to retry or take a different action.
                  maxLength: 100
                  example: null
              example: null
          required:
          - created_at
          - modified_at
          - status
          example: null
        payment_attempts:
          type: array
          deprecated: false
          description: |-
            <p class="mb-2">List of payment attempts associated with this PaymentIntent. Each item in the list is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_attempt</code>
            object, identical in structure to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active_payment_attempt</code>
            .</p>
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier for the payment attempt.
                maxLength: 70
                example: null
              status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Current status of the payment attempt.</p>
                  * inited - <p class="mb-2">Payment attempt is initialized.</p>
                  * requires_challenge - <p class="mb-2">The transaction requires the 3DS Challenge flow, where the customer completes authentication through an inline 3DS 2.0 challenge presented by their card issuer.</p>
                  * authorized - <p class="mb-2">3DS verification successfully completed.</p>
                  * requires_identification - <p class="mb-2">Customer&#x27;s device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.</p>
                  * pending_authorization - <p class="mb-2">Waiting for the authorization.</p>
                  * requires_redirection - <p class="mb-2">The transaction must go through the 3DS Redirection flow, where the customer is redirected to their card issuer&#x27;s authentication page (3DS 1.0) to verify the payment. After authentication, the customer is redirected to the specified <code><a href="/docs/api/payment_intents/payment_intent-object#success_url">success_url</a></code>
                  or <code><a href="/docs/api/payment_intents/payment_intent-object#failure_url">failure_url</a></code>
                  .</p>
                  * refused - <p class="mb-2">3DS verification attempt failed.</p>
                enum:
                - inited
                - requires_identification
                - requires_challenge
                - requires_redirection
                - authorized
                - refused
                - pending_authorization
                example: null
              payment_method_type:
                type: string
                default: card
                deprecated: false
                description: |
                  The payment method of this attempt.
                  \* swish -

                  Payments made via Swish
                  \* stablecoin -

                  Payments made via Stablecoin.
                  \* upi -

                  upi
                  \* revolut_pay -

                  Payments made via Revolut Pay.
                  \* cash_app_pay -

                  Payments made via Cash App Pay.
                  \* direct_debit -

                  direct_debit
                  \* netbanking_emandates -

                  netbanking_emandates
                  \* amazon_payments -

                  amazon_payments
                  \* sepa_instant_transfer -

                  SEPA Instant Transfer
                  \* klarna_pay_now -

                  Klarna Pay Now
                  \* alipay -

                  Payments made via Alipay.
                  \* dotpay -

                  dotpay
                  \* google_pay -

                  google_pay
                  \* sofort -

                  sofort
                  \* giropay -

                  giropay
                  \* payconiq_by_bancontact -

                  Payments made via Payconiq by Bancontact.
                  \* payme -

                  Payments made via PayMe
                  \* electronic_payment_standard -

                  Electronic Payment Standard
                  \* boleto -

                  boleto
                  \* kakao_pay -

                  Payments made via Kakao Pay.
                  \* pix -

                  Pix
                  \* kbc_payment_button -

                  KBC Payment Button
                  \* card -

                  card
                  \* faster_payments -

                  Faster Payments
                  \* naver_pay -

                  Payments made via Naver Pay.
                  \* paypal_express_checkout -

                  paypal_express_checkout
                  \* ideal -

                  ideal
                  \* go_pay -

                  Payments made via GoPay
                  \* grab_pay -

                  Payments made via GrabPay
                  \* pay_co -

                  Payments made via PayCo
                  \* pay_by_bank -

                  Pay By Bank
                  \* venmo -

                  Venmo
                  \* after_pay -

                  Payments made via Afterpay
                  \* bancontact -

                  bancontact
                  \* trustly -

                  Trustly
                  \* wechat_pay -

                  Payments made via WeChat Pay.
                  \* twint -

                  Payments made via Twint
                  \* apple_pay -

                  apple_pay
                  \* pay_to -

                  PayTo
                enum:
                - card
                - ideal
                - sofort
                - bancontact
                - google_pay
                - dotpay
                - giropay
                - apple_pay
                - upi
                - netbanking_emandates
                - paypal_express_checkout
                - direct_debit
                - boleto
                - venmo
                - amazon_payments
                - pay_to
                - faster_payments
                - sepa_instant_transfer
                - klarna_pay_now
                - online_banking_poland
                - payconiq_by_bancontact
                - electronic_payment_standard
                - kbc_payment_button
                - pay_by_bank
                - trustly
                - stablecoin
                - kakao_pay
                - naver_pay
                - revolut_pay
                - cash_app_pay
                - wechat_pay
                - alipay
                - twint
                - go_pay
                - grab_pay
                - pay_co
                - after_pay
                - swish
                - payme
                - pix
                - klarna
                example: null
              id_at_gateway:
                type: string
                deprecated: false
                description: |
                  Reference of the payment attempt at the gateway.
                maxLength: 50
                example: null
              error_code:
                type: string
                deprecated: false
                description: |
                  Error code received from the payment gateway on failure.
                maxLength: 100
                example: null
              error_text:
                type: string
                deprecated: false
                description: |
                  Error message received from the payment gateway on failure.
                maxLength: 65000
                example: null
              checkout_details:
                type: string
                deprecated: false
                description: |
                  JSON-encoded object that includes customer and browser details collected during checkout.
                maxLength: 65000
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when the payment attempt was created.
                example: null
              modified_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when the payment attempt was last modified.
                example: null
              error_detail:
                type: object
                deprecated: false
                description: |
                  Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about \[gateway error references\](/docs/api/v2/pcv-1/gateway_error_references)
                properties:
                  request_id:
                    type: string
                    deprecated: false
                    description: |
                      This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
                    maxLength: 100
                    example: null
                  error_category:
                    type: string
                    deprecated: false
                    description: |
                      This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
                    maxLength: 100
                    example: null
                  error_code:
                    type: string
                    deprecated: false
                    description: |
                      A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
                    maxLength: 100
                    example: null
                  error_message:
                    type: string
                    deprecated: false
                    description: |
                      A message provided by the gateway that describes the nature of the error encountered
                    maxLength: 65000
                    example: null
                  decline_code:
                    type: string
                    deprecated: false
                    description: |
                      Code provided by the gateway that specifies the reason for the transaction decline.
                    maxLength: 100
                    example: null
                  decline_message:
                    type: string
                    deprecated: false
                    description: |
                      Descriptive message explaining the reason for the transaction's decline.
                    maxLength: 65000
                    example: null
                  network_error_code:
                    type: string
                    deprecated: false
                    description: |
                      This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
                    maxLength: 100
                    example: null
                  network_error_message:
                    type: string
                    deprecated: false
                    description: |
                      This is the network-related error message from the gateway; a detailed message provided by the payment network explaining the nature of the network error encountered
                    maxLength: 65000
                    example: null
                  error_field:
                    type: string
                    deprecated: false
                    description: |
                      This parameter indicates which specific data field or attribute in the request caused the error
                    maxLength: 100
                    example: null
                  recommendation_code:
                    type: string
                    deprecated: false
                    description: |
                      After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
                    maxLength: 100
                    example: null
                  recommendation_message:
                    type: string
                    deprecated: false
                    description: |
                      This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
                    maxLength: 65000
                    example: null
                  processor_error_code:
                    type: string
                    deprecated: false
                    description: |
                      This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
                    maxLength: 100
                    example: null
                  processor_error_message:
                    type: string
                    deprecated: false
                    description: |
                      This message describes the specific error that the payment processor encountered
                    maxLength: 65000
                    example: null
                  error_cause_id:
                    type: string
                    deprecated: false
                    description: |
                      A [Chargebee-defined code](/docs/api/errors)
                      that corresponds to the specific error encountered during the request. This code helps in identifying and standardizing the error across different gateway services for consistent error handling.
                    maxLength: 150
                    example: null
                  processor_advice_code:
                    type: string
                    deprecated: false
                    description: |
                      Advice code returned by the payment gateway or processor that provides guidance on how to handle a declined transaction, for example, whether to retry or take a different action.
                    maxLength: 100
                    example: null
                example: null
            required:
            - created_at
            - modified_at
            - status
            example: null
          example: null
      required:
      - amount
      - created_at
      - customer_id
      - expires_at
      - id
      - modified_at
      - status
      example: null
    PaymentIntentCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            payment_intent:
              $ref: "#/components/schemas/PaymentIntent"
          required:
          - payment_intent
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentIntentUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            payment_intent:
              $ref: "#/components/schemas/PaymentIntent"
          required:
          - payment_intent
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentMethod:
      type: string
      default: card
      deprecated: false
      enum:
      - cash
      - check
      - bank_transfer
      - other
      - custom
      - chargeback
      - card
      - amazon_payments
      - paypal_express_checkout
      - direct_debit
      - alipay
      - unionpay
      - apple_pay
      - wechat_pay
      - ach_credit
      - sepa_credit
      - ideal
      - google_pay
      - sofort
      - bancontact
      - giropay
      - dotpay
      - upi
      - netbanking_emandates
      - boleto
      - venmo
      - pay_to
      - faster_payments
      - sepa_instant_transfer
      - automated_bank_transfer
      - klarna_pay_now
      - online_banking_poland
      - payconiq_by_bancontact
      - electronic_payment_standard
      - kbc_payment_button
      - pay_by_bank
      - trustly
      - stablecoin
      - kakao_pay
      - naver_pay
      - revolut_pay
      - cash_app_pay
      - pix
      - twint
      - go_pay
      - grab_pay
      - pay_co
      - after_pay
      - swish
      - payme
      - klarna
      example: null
    PaymentMethodSavePolicy:
      type: string
      deprecated: false
      enum:
      - always
      - ask
      - never
      example: null
    PaymentMethodType:
      type: string
      deprecated: false
      enum:
      - card
      - paypal_express_checkout
      - amazon_payments
      - direct_debit
      - generic
      - alipay
      - unionpay
      - apple_pay
      - wechat_pay
      - ideal
      - google_pay
      - sofort
      - bancontact
      - giropay
      - dotpay
      - upi
      - netbanking_emandates
      - venmo
      - pay_to
      - faster_payments
      - sepa_instant_transfer
      - automated_bank_transfer
      - klarna_pay_now
      - online_banking_poland
      - payconiq_by_bancontact
      - electronic_payment_standard
      - kbc_payment_button
      - pay_by_bank
      - trustly
      - stablecoin
      - kakao_pay
      - naver_pay
      - revolut_pay
      - cash_app_pay
      - twint
      - go_pay
      - grab_pay
      - pay_co
      - after_pay
      - swish
      - payme
      - pix
      - klarna
      example: null
    PaymentReferenceNumber:
      type: object
      description: |
        Using this resource you can create reference numbers for Payment Instructions at the invoice level, allowing for multiple payment information and payment reference numbers to be associated with a single invoice. However, only one PRN is generated for each payment method.
      properties:
        id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
            resource is a unique identifier assigned to the PRN to track and reference in systems.</p>
          maxLength: 40
          example: null
        type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This attribute helps <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            field in the API, specifies how to reconcile offline payments, and generate <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
            on invoices based on country-specific rules. Setting the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            field generates <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reference_number</code>
            for the respective country and includes them on the invoice for correct reconciliation.</p>
            * frn - <p class="mb-2">The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.</p>
            * fik - <p class="mb-2">Denmark based number calculated using recursive MOD 10 algorithm.</p>
            * kid - <p class="mb-2">The KID number (kundeidentifikasjon) in Norway is an abbreviation for &quot;Customer identification&quot;. It is used to associate payments with the customer and invoice.</p>
            * ocr - <p class="mb-2">A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.</p>
          enum:
          - kid
          - ocr
          - frn
          - fik
          - swiss_reference
          example: null
        number:
          type: string
          deprecated: false
          description: |
            A number is generated based on the configuration type of the PRN during the invoice creation process.
          maxLength: 100
          example: null
        invoice_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice_id</code>
            of the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.</p>
          maxLength: 50
          example: null
      required:
      - id
      - number
      - type
      example: null
    PaymentRefundedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_note:
              $ref: "#/components/schemas/CreditNote"
            customer:
              $ref: "#/components/schemas/Customer"
            subscription:
              $ref: "#/components/schemas/Subscription"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - credit_note
          - customer
          - invoice
          - subscription
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSchedule:
      type: object
      description: |-
        <div class="api-description"><span featureId="cb-payment-schedules"></span><p class="mb-2">Payment schedules for an invoice refer to a payment structure where the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount_due</code>
        on an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period.</p></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            An auto-generated unique identifier for the payment schedule.
          maxLength: 40
          example: null
        scheme_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The identifier of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_schedule_scheme</code>
            , used to create the payment schedules.</p>
          maxLength: 40
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Specifies the types of entity this payment schedule is based on.
            \* invoice -

            invoice
          enum:
          - invoice
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            The identifier of the entity this payment schedule is based on.
          maxLength: 50
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Defines the amount set for an invoice as part of payment schedules. If this is not sent, the total invoice due amount will be taken as payment schedule amount
          minimum: 0
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies when these payment schedules are created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies when these payment schedules are updated recently.
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the transaction amount.
          maxLength: 3
          example: null
        schedule_entries:
          type: array
          deprecated: false
          description: |
            List of schedule entries
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An auto-generated unique identifier for the payment schedules.
                maxLength: 40
                example: null
              date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  date at which this payment schedule is scheduled
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  total maximum amount that this payment schedule is allowed to collect
                minimum: 0
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  Defines the status for each payment schedule.
                  \* posted -

                  posted
                  \* payment_due -

                  payment_due
                  \* paid -

                  paid
                enum:
                - posted
                - payment_due
                - paid
                example: null
            required:
            - amount
            - date
            - id
            - status
            example: null
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - id
      - scheme_id
      example: null
    PaymentScheduleEstimate:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        scheme_id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - invoice
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        schedule_entries:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            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
                minimum: 0
                example: null
              status:
                type: string
                deprecated: false
                enum:
                - posted
                - payment_due
                - paid
                example: null
            required:
            - amount
            - date
            - id
            - status
            example: null
          example: null
      required:
      - amount
      - entity_type
      - id
      - scheme_id
      example: null
    PaymentSource:
      type: object
      description: |
        **Updates**

        This API obsoletes the [Cards API](/docs/api/cards)
        in Chargebee.

        Represents the payment source for the customer. Specific types of payment source (Card, Direct Debit, Paypal Express Checkout, etc.) is defined as sub-resource in the response object. You can find the list of supported payment sources and the expected input parameters [here](/docs/api/payment_parameters). See [Payment source attributes](/docs/api/payment_sources/payment-source-object) for a descriptive list of attributes and payment source types.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Identifier of the payment source
          maxLength: 40
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this payment source resource was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this payment source resource is created.
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer with whom this payment source is associated.
          maxLength: 50
          example: null
        type:
          type: string
          deprecated: false
          description: "Type of payment source\n\\* direct_debit -\n\nRepresents bank\
            \ account for which the direct debit or ACH agreement/mandate is created.\n\
            \\* unionpay -\n\nPayments made via UnionPay.\n\\* sepa_instant_transfer\
            \ -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments\
            \ made via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\\* grab_pay\
            \ -\n\nPayments made via GrabPay\n\\* stablecoin -\n\nPayments made via\
            \ Stablecoin.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\
            \\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* pay_by_bank\
            \ -\n\nPay By Bank\n\\* online_banking_poland -\n\nPayments made via Online\
            \ Banking Poland\n\\* after_pay -\n\nPayments made via Afterpay\n\\* generic\
            \ -\n\nPayments made via Generic Payment Method.\n\\* twint -\n\nPayments\
            \ made via Twint\n\\* automated_bank_transfer -\n\nRepresents virtual\
            \ bank account using which the payment will be done.\n\\* paypal_express_checkout\
            \ -\n\nPayments made via PayPal Express Checkout.\n\\* trustly -\n\nTrustly\n\
            \\* upi -\n\nUPI Payments.\n\\* cash_app_pay -\n\nPayments made via Cash\
            \ App Pay.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\
            \\* google_pay -\n\nPayments made via Google Pay.\n\\* pay_to -\n\nPayments\
            \ made via PayTo\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\
            \\* naver_pay -\n\nPayments made via Naver Pay.\n\\* alipay -\n\nPayments\
            \ made via Alipay.  \nThis payment source is deprecated.\n\\* kakao_pay\
            \ -\n\nPayments made via Kakao Pay.\n\\* sofort -\n\nPayments made via\
            \ Sofort.\n\\* pix -\n\nPayments made via Pix\n\\* pay_co -\n\nPayments\
            \ made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay.  \n\
            This payment source is deprecated.\n\\* netbanking_emandates -\n\nNetbanking\
            \ (eMandates) Payments.\n\\* go_pay -\n\nPayments made via GoPay\n\\*\
            \ card -\n\nCard based payment including credit cards and debit cards.\
            \ Details about the card can be obtained from the card resource.\n\\*\
            \ faster_payments -\n\nPayments made via Faster Payments\n\\* payme -\n\
            \nPayments made via PayMe\n\\* klarna_pay_now -\n\nPayments made via Klarna\
            \ Pay Now\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments\
            \ made via Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\\* kbc_payment_button\
            \ -\n\nKBC Payment Button\n\\* payconiq_by_bancontact -\n\nPayments made\
            \ via Payconiq by Bancontact.\n\\* apple_pay -\n\nPayments made via Apple\
            \ Pay.\n"
          enum:
          - card
          - paypal_express_checkout
          - amazon_payments
          - direct_debit
          - generic
          - alipay
          - unionpay
          - apple_pay
          - wechat_pay
          - ideal
          - google_pay
          - sofort
          - bancontact
          - giropay
          - dotpay
          - upi
          - netbanking_emandates
          - venmo
          - pay_to
          - faster_payments
          - sepa_instant_transfer
          - automated_bank_transfer
          - klarna_pay_now
          - online_banking_poland
          - payconiq_by_bancontact
          - electronic_payment_standard
          - kbc_payment_button
          - pay_by_bank
          - trustly
          - stablecoin
          - kakao_pay
          - naver_pay
          - revolut_pay
          - cash_app_pay
          - twint
          - go_pay
          - grab_pay
          - pay_co
          - after_pay
          - swish
          - payme
          - pix
          - klarna
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource.
            **Note:**
            This is not the one time temporary token provided by gateways like Stripe.
          maxLength: 200
          example: null
        status:
          type: string
          default: valid
          deprecated: false
          description: |
            Current status of the payment source.
            \* valid -

            A payment source that is valid and active.
            \* expiring -

            A payment source that is expiring (like card's status based on its expiry date).
            \* invalid -

            The billing agreement cannot be used. It might become valid again either automatically or due to customer action.
            \* pending_verification -

            The payment source needs to be verified
            \* expired -

            A payment source that has expired
          enum:
          - valid
          - expiring
          - expired
          - invalid
          - pending_verification
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Name of the gateway this payment source is stored with.\n\\\
            * bluesnap -\n\nBlueSnap is a payment gateway.\n\\* jp_morgan -\n\nJ.P.\
            \ Morgan Mobility Payment Solutions is a payment gateway that enables\
            \ you to securely accept and manage digital payments across different\
            \ [payment_source_type](/docs/api/payment_sources/payment_source-object#type).\
            \  \nThis feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature)\
            \ to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL\
            \ for your test and live sites.\n\\* tco -\n\n2Checkout is a payment gateway.\n\
            \\* razorpay -\n\nRazorpay is a fast growing payment service provider\
            \ in India working with all leading banks and support for major local\
            \ payment methods including Netbanking, UPI etc.\n\\* dlocal -\n\nDlocal\
            \ provides payment solutions for global commerce by accepting local payment\
            \ methods.\n\\* checkout_com -\n\nCheckout.com is a payment gateway.\n\
            \\* adyen -\n\nAdyen is a payment gateway.\n\\* braintree -\n\nBraintree\
            \ is a payment gateway.\n\\* paystack -\n\nPaystack is a payment gateway\
            \ for businesses in Africa. It enables secure payment acceptance both\
            \ online and offline.  \nThis feature is a **Private Beta Release** .\
            \ [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
            \ to enable Paystack for your test and live sites.\n\\* pay_com -\n\n\
            Pay.com provides payment services focused on simplicity and hassle-free\
            \ operations for businesses of all sizes.\n\\* moneris_us -\n\nMoneris\
            \ USA is a payment gateway.\n\\* pin -\n\nPin is a payment gateway\n\\\
            * moneris -\n\nMoneris is a payment gateway.\n\\* chargebee -\n\nChargebee\
            \ test gateway.\n\\* cybersource -\n\nCyberSource is a payment gateway.\n\
            \\* ecentric -\n\nEcentric provides a seamless payment processing service\
            \ in South Africa specializing on omnichannel capabilities.\n\\* first_data_global\
            \ -\n\nFirst Data Global Gateway Virtual Terminal Account\n\\* exact -\n\
            \nExact Payments is a payment gateway.\n\\* nuvei -\n\nNuvei is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \nThis\
            \ feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
            \ to enable Nuvei for your test and live sites.\n\\* eway -\n\neWAY Account\
            \ is a payment gateway.\n\\* amazon_payments -\n\nAmazon Payments is a\
            \ payment service provider.\n\\* sage_pay -\n\nSage Pay is a payment gateway.\n\
            \\* elavon -\n\nElavon Virtual Merchant is a payment solution.\n\\* orbital\
            \ -\n\nChase Paymentech(Orbital) is a payment gateway.\n\\* beanstream\
            \ -\n\nBambora(formerly known as Beanstream) is a payment gateway.\n\\\
            * hdfc -\n\nHDFC Account is a payment gateway.\n\\* bank_of_america -\n\
            \nBank of America Gateway\n\\* gocardless -\n\nGoCardless is a payment\
            \ service provider.\n\\* paymill -\n\nPAYMILL is a payment gateway.\n\\\
            * balanced_payments -\n\nBalanced is a payment gateway\n\\* twikey -\n\
            \nTwikey is a payment service provider that specializes in processing\
            \ direct debit payments across the EU.\n\\* deutsche_bank -\n\nDeutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \nThis feature is a **Private Beta Release**.\n\\* bluepay\
            \ -\n\nBluePay is a payment gateway.\n\\* paypal_express_checkout -\n\n\
            PayPal Express Checkout is a payment gateway.\n\\* paypal_payflow_pro\
            \ -\n\nPayPal Payflow Pro is a payment gateway.\n\\* global_payments -\n\
            \nGlobal Payments is a payment service provider.\n\\* not_applicable -\n\
            \nIndicates that payment gateway is not applicable for this resource.\n\
            \\* nmi -\n\nNMI is a payment gateway.\n\\* worldpay -\n\nWorldPay is\
            \ a payment gateway\n\\* authorize_net -\n\nAuthorize.net is a payment\
            \ gateway\n\\* stripe -\n\nStripe is a payment gateway.\n\\* metrics_global\
            \ -\n\nMetrics global is a leading payment service provider providing\
            \ unified payment services in the US.\n\\* windcave -\n\nWindcave provides\
            \ an end to end payment processing solution in ANZ and other leading global\
            \ markets.\n\\* quickbooks -\n\nIntuit QuickBooks Payments gateway\n\\\
            * wepay -\n\nWePay is a payment gateway.\n\\* ezidebit -\n\nEzidebit is\
            \ a payment gateway integration based in Australia that supports automated\
            \ direct debit, BPAY, and card payments for businesses.  \nThis feature\
            \ is a **Private Beta Release**.\n\\* wirecard -\n\nWireCard Account is\
            \ a payment service provider.\n\\* chargebee_payments -\n\nChargebee Payments\
            \ gateway\n\\* paypal_pro -\n\nPayPal Pro Account is a payment gateway.\n\
            \\* paypal -\n\nPayPal Commerce is a payment gateway.\n\\* ingenico_direct\
            \ -\n\nWorldline Online Payments is a payment gateway.\n\\* ogone -\n\n\
            Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n\\\
            * migs -\n\nMasterCard Internet Gateway Service payment gateway.\n\\*\
            \ vantiv -\n\nVantiv is a payment gateway.\n\\* eway_rapid -\n\neWAY Rapid\
            \ is a payment gateway.\n\\* mollie -\n\nMollie is a payment gateway.\n\
            \\* solidgate -\n\nSolidgate is a secure and reliable payment processing\
            \ solution that allows you to accept payments from customers and suitable\
            \ for various types of businesses.  \nThis feature is a **Private Beta\
            \ Release**.\n\\* ebanx -\n\nEBANX is a payment gateway, enabling businesses\
            \ to accept diverse local payment methods from various countries for increased\
            \ market reach and conversion.\n"
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account to which this payment source is stored with.
          maxLength: 50
          example: null
        ip_address:
          type: string
          deprecated: false
          description: |
            The IP address of the customer. Used primarily for referral integration and EU VAT validation.
          maxLength: 50
          example: null
        issuing_country:
          type: string
          deprecated: false
          description: |
            [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)
            ISO country code.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        card:
          type: object
          deprecated: false
          description: |
            Card details associated with this payment source.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                Cardholder's first name
              maxLength: 50
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                Cardholder's last name
              maxLength: 50
              example: null
            email:
              type: string
              format: email
              deprecated: false
              maxLength: 70
              example: null
            iin:
              type: string
              deprecated: false
              description: |
                The Issuer Identification Number, i.e. the first six digits of the card number
              maxLength: 6
              minLength: 6
              example: null
            last4:
              type: string
              deprecated: false
              description: |
                Last four digits of the card number
              maxLength: 4
              minLength: 4
              example: null
            brand:
              type: string
              deprecated: false
              description: |
                Card brand
                \* cartes_bancaires -

                A Cartes Bancaires card.
                \* not_applicable -

                Used for offline entries in transactions. Not applicable for cards
                \* maestro -

                A Maestro card.
                \* dankort -

                A Dankort card.
                \* tarjeta_naranja -

                A Tarjeta Naranja card.
                \* jcb -

                A JCB card.
                \* other -

                Card belonging to types other than those listed above.
                \* trustly -

                Trustly
                \* electronic_payment_standard -

                Electronic Payment Standard
                \* cmr_falabella -

                A CMR Falabella card.
                \* discover -

                A Discover card.
                \* elo -

                A Elo card.
                \* diners_club -

                A Diner's Club card.
                \* mada -

                A Mada card.
                \* cabal -

                A Cabal card.
                \* american_express -

                An American Express card.
                \* visa -

                A Visa card.
                \* cencosud -

                A Cencosud card.
                \* carnet -

                A Carnet card.
                \* argencard -

                An Argencard.
                \* mastercard -

                A MasterCard.
                \* pay_by_bank -

                Pay By Bank
                \* hipercard -

                An Hipercard.
                \* bancontact -

                A Bancontact card.
                \* rupay -

                A Rupay card.
                \* nativa -

                A Nativa card.
                \* kbc_payment_button -

                KBC Payment Button
              enum:
              - visa
              - mastercard
              - american_express
              - discover
              - jcb
              - diners_club
              - other
              - bancontact
              - cmr_falabella
              - tarjeta_naranja
              - nativa
              - cencosud
              - cabal
              - argencard
              - elo
              - hipercard
              - carnet
              - rupay
              - maestro
              - dankort
              - cartes_bancaires
              - mada
              - not_applicable
              example: null
            funding_type:
              type: string
              deprecated: false
              description: |
                Card Funding type
                \* not_known -

                An unknown card.
                \* debit -

                A debit card.
                \* credit -

                A credit card.
                \* not_applicable -

                Used for ACH. Not applicable for cards
                \* prepaid -

                A prepaid card.
              enum:
              - credit
              - debit
              - prepaid
              - not_known
              - not_applicable
              example: null
            expiry_month:
              type: integer
              format: int32
              deprecated: false
              description: |
                Card expiry month.
              maximum: 12
              minimum: 1
              example: null
            expiry_year:
              type: integer
              format: int32
              deprecated: false
              description: |
                Card expiry year.
              example: null
            billing_addr1:
              type: string
              deprecated: false
              description: |
                Address line 1, as available in card billing address.
              maxLength: 150
              example: null
            billing_addr2:
              type: string
              deprecated: false
              description: |
                Address line 2, as available in card billing address.
              maxLength: 150
              example: null
            billing_city:
              type: string
              deprecated: false
              description: |
                City, as available in card billing address.
              maxLength: 50
              example: null
            billing_state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            billing_state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            billing_country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            billing_zip:
              type: string
              deprecated: false
              description: |
                Postal or Zip code, as available in card billing address.
              maxLength: 20
              example: null
            masked_number:
              type: string
              deprecated: false
              description: |
                Masked credit card number that is safe to show.
              maxLength: 19
              example: null
          required:
          - brand
          - expiry_month
          - expiry_year
          - funding_type
          - iin
          - last4
          example: null
        bank_account:
          type: object
          deprecated: false
          description: |
            Bank account details the direct debit or ACH or NetBanking agreement/mandate created with this payment source.
          properties:
            last4:
              type: string
              deprecated: false
              description: |
                Last four digits of the bank account number
              maxLength: 4
              minLength: 4
              example: null
            name_on_account:
              type: string
              deprecated: false
              description: |
                Account holder's name as per bank account.
              maxLength: 300
              example: null
            first_name:
              type: string
              deprecated: false
              description: |
                Account holder's first name as per bank account.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                Account holder's last name as per bank account.
              maxLength: 150
              example: null
            direct_debit_scheme:
              type: string
              deprecated: false
              description: |
                Bank account's scheme to which the mandate and associated payments are submitted.
                \* becs_nz -

                The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in New-Zealand for Direct Debit system.
                \* becs -

                The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in Australia for Direct Debit system.
                \* pad -

                Pre-Authorized Debit (PAD) is the scheme used for collecting Direct Debit payments from customers in Canada.
                \* ach -

                US Bank Account
                \* sepa_core -

                SEPA Direct Debit is a Europe-wide Direct Debit system that allows merchants to collect Euro-denominated payments.
                \* autogiro -

                Bg Autogiro is a Direct Debit scheme for collecting Krona-denominated payments from a bank account in Sweden.
                \* bacs -

                Automated payments are at the very centre of the UK's financial system, providing an essential service for both consumers and organisations. Bacs is the company which runs Direct Debit in the UK.
                \* not_applicable -

                not_applicable
              enum:
              - ach
              - bacs
              - sepa_core
              - autogiro
              - becs
              - becs_nz
              - pad
              - not_applicable
              example: null
            bank_name:
              type: string
              deprecated: false
              description: |
                Name of account holder's bank.
              maxLength: 100
              example: null
            mandate_id:
              type: string
              deprecated: false
              description: |
                Mandate Id. Applicable for SEPA, BACS, Autogiro, and BECS.
              maxLength: 50
              minLength: 1
              example: null
            account_type:
              type: string
              deprecated: false
              description: |
                Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/)
                ACH and Razorpay NetBanking users only. If not passed, account type is taken as null.
                \* checking -

                Checking Account
                \* business_checking -

                Business Checking Account
                \* savings -

                Savings Account
                \* current -

                Current Account
              enum:
              - checking
              - savings
              - business_checking
              - current
              example: null
            echeck_type:
              type: string
              deprecated: false
              description: |
                For Authorize.net ACH users only. Indicates the type of eCheck.
                \* ppd -

                Payment Authorization is prearranged between the customer and the merchant.
                \* ccd -

                Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
                \* web -

                Payment Authorization obtained from the customer via the internet.
              enum:
              - web
              - ppd
              - ccd
              example: null
            account_holder_type:
              type: string
              deprecated: false
              description: |
                For Stripe ACH users only. Indicates the account holder type.
                \* individual -

                Individual Account.
                \* company -

                Company Account.
              enum:
              - individual
              - company
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
              maxLength: 70
              example: null
          required:
          - last4
          example: null
        boleto:
          type: object
          deprecated: false
          description: |
            Boleto payment source details of the customer
          properties:
            last4:
              type: string
              deprecated: false
              description: |
                Last four digits of unique id for voucher payment source ex: tax_id
              maxLength: 4
              minLength: 4
              example: null
            first_name:
              type: string
              deprecated: false
              description: |
                Customer first name as per voucher payment source.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                Customer last name as per voucher payment source.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Email address associated Customer's voucher payment source.
              maxLength: 70
              example: null
          required:
          - last4
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for the payment source.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
                \* not_validated -

                Address is not yet validated.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        amazon_payment:
          type: object
          deprecated: false
          description: |
            Amazon payments details associated with this payment source.
          properties:
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Email address associated with Amazon payment account
              maxLength: 70
              example: null
            agreement_id:
              type: string
              deprecated: false
              description: |
                Billing agreement id
              maxLength: 50
              example: null
          example: null
        upi:
          type: object
          deprecated: false
          description: |
            Represents the payment method that allows you to make payments directly using a bank account.
          properties:
            vpa:
              type: string
              deprecated: false
              description: |
                A unique identifier mapped with an individuals bank account to help UPI track the account.
              maxLength: 100
              example: null
          example: null
        paypal:
          type: object
          deprecated: false
          description: |
            PayPal Express Checkout details associated with this payment source.
          properties:
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Email address associated with PayPal Express Checkout
              maxLength: 70
              example: null
            agreement_id:
              type: string
              deprecated: false
              description: |
                Billing agreement id
              maxLength: 50
              example: null
          example: null
        venmo:
          type: object
          deprecated: false
          description: |
            Venmo details associated with this payment source.
          properties:
            user_name:
              type: string
              deprecated: false
              description: |
                User name associated with customer's account in Venmo
              maxLength: 50
              example: null
          example: null
        klarna_pay_now:
          type: object
          deprecated: false
          description: |
            Klarna Pay Now payment source details of the customer
          properties:
            email:
              type: string
              format: email
              deprecated: false
              description: |
                Email address associated Customer's klarna payment source.
              maxLength: 70
              example: null
          example: null
        mandates:
          type: array
          deprecated: false
          description: |
            Mandate details associated with the payment source.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique mandate identifier used for recurring payments.
                maxLength: 250
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  Chargebee's subscription id used to find the mapping between the payment source and the Subscription.
                maxLength: 50
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when the mandate is created
                example: null
            required:
            - created_at
            - id
            - subscription_id
            example: null
          example: null
      required:
      - created_at
      - customer_id
      - deleted
      - gateway
      - id
      - reference_id
      - status
      - type
      example: null
    PaymentSourceAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSourceDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSourceExpiredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSourceExpiringEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSourceLocallyDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSourceUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - customer
          - payment_source
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSucceededEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
            invoice:
              $ref: "#/components/schemas/Invoice"
            customer:
              $ref: "#/components/schemas/Customer"
            subscription:
              $ref: "#/components/schemas/Subscription"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - customer
          - invoice
          - subscription
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentVoucher:
      type: object
      description: "The Payment Voucher resource represents a voucher that has been\
        \ created for a customer to initiate voucher-based payment. This resource\
        \ contains relevant details such as the voucher URL, the amount of the voucher,\
        \ the status of the voucher, and more. Currently, the only supported voucher-based\
        \ payment source is Boleto. Boleto is a payment method in Brazil that is regulated\
        \ by the Central Bank of Brazil and is considered an official form of payment.\
        \ This is also a popular voucher-based payment method in Brazil.  \n**Note:**\n\
        This resource can be extended in the future to support other types of payment\
        \ sources for vouchers.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies the payment voucher.
          maxLength: 40
          example: null
        id_at_gateway:
          type: string
          deprecated: false
          description: |
            The id with which this voucher is referred in gateway.
          maxLength: 100
          example: null
        payment_voucher_type:
          type: string
          deprecated: false
          description: |
            Type of the payment source.
            \* boleto -

            Boleto
          enum:
          - boleto
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the Voucher will expire if left unconsumed.
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of Payment Voucher.
            \* consumed -

            Consumed for a transaction and cannot be used again
            \* expired -

            Expired before consumed and cannot be used again
            \* active -

            Active and ready to be consumed
            \* failure -

            Failed to create the voucher due to gateway rejection
          enum:
          - active
          - consumed
          - expired
          - failure
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            Identifier of the subscription for which this payment voucher is made.
          maxLength: 50
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the voucher.
          maxLength: 3
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount for this payment voucher.
          minimum: 1
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account used for this voucher
          maxLength: 50
          example: null
        payment_source_id:
          type: string
          deprecated: false
          description: |
            Identifier of the payment source for which this payment voucher is created
          maxLength: 40
          example: null
        gateway:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The gateway through which this payment voucher was created.
            <strong class="font-semibold">Note</strong>:
            Note: Currently, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stripe</code>
            is the only supported gateway through which you can create the payment voucher.</p>
            * twikey - <p class="mb-2">Twikey is a payment service provider that specializes in processing direct debit payments across the EU. <span featureId="cb-twikey" isMicro="true"></span></p>
            * ecentric - <p class="mb-2">Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.</p>
            * bluesnap - <p class="mb-2">BlueSnap is a payment gateway.</p>
            * jp_morgan - <p class="mb-2">J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a href="/docs/api/payment_sources/payment_source-object#type" class="text-blue-600 hover:text-blue-800 underline">payment_source_type</a>.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>. <a href="https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&amp;ref=feature" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Request access</a> to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites.</p></div>
            * tco - <p class="mb-2">2Checkout is a payment gateway.</p>
            * first_data_global - <p class="mb-2">First Data Global Gateway Virtual Terminal Account</p>
            * exact - <p class="mb-2">Exact Payments is a payment gateway.</p>
            * deutsche_bank - <p class="mb-2">Deutsche Bank is the leading German bank with strong European roots and a global network.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>.</p></div>
            * bluepay - <p class="mb-2">BluePay is a payment gateway.</p>
            * paypal_express_checkout - <p class="mb-2">PayPal Express Checkout is a payment gateway.</p>
            * nuvei - <p class="mb-2">Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>. <a href="https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&amp;ref=feature" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Request access</a> to enable Nuvei for your test and live sites.</p></div>
            * eway - <p class="mb-2">eWAY Account is a payment gateway.</p>
            * metrics_global - <p class="mb-2">Metrics global is a leading payment service provider providing unified payment services in the US.</p>
            * paypal_payflow_pro - <p class="mb-2">PayPal Payflow Pro is a payment gateway.</p>
            * razorpay - <p class="mb-2">Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.</p>
            * global_payments - <p class="mb-2">Global Payments is a payment service provider.</p>
            * amazon_payments - <p class="mb-2">Amazon Payments is a payment service provider.</p>
            * dlocal - <p class="mb-2">Dlocal provides payment solutions for global commerce by accepting local payment methods.</p>
            * not_applicable - <p class="mb-2">Indicates that payment gateway is not applicable for this resource.</p>
            * windcave - <p class="mb-2">Windcave provides an end to end payment processing solution in ANZ and other leading global markets.</p>
            * checkout_com - <p class="mb-2">Checkout.com is a payment gateway.</p>
            * adyen - <p class="mb-2">Adyen is a payment gateway.</p>
            * braintree - <p class="mb-2">Braintree is a payment gateway.</p>
            * nmi - <p class="mb-2">NMI is a payment gateway.</p>
            * quickbooks - <p class="mb-2">Intuit QuickBooks Payments gateway</p>
            * wepay - <p class="mb-2">WePay is a payment gateway.</p>
            * worldpay - <p class="mb-2">WorldPay is a payment gateway</p>
            * paystack - <p class="mb-2">Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both   online and offline.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>. <a href="https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&amp;ref=feature" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Request access</a> to enable Paystack for your test and live sites.</p></div>
            * ezidebit - <p class="mb-2">Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>.</p></div>
            * pay_com - <p class="mb-2">Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.</p>
            * wirecard - <p class="mb-2">WireCard Account is a payment service provider.</p>
            * chargebee_payments - <p class="mb-2">Chargebee Payments gateway</p>
            * sage_pay - <p class="mb-2">Sage Pay is a payment gateway.</p>
            * moneris_us - <p class="mb-2">Moneris USA is a payment gateway.</p>
            * pin - <p class="mb-2">Pin is a payment gateway</p>
            * authorize_net - <p class="mb-2">Authorize.net is a payment gateway</p>
            * elavon - <p class="mb-2">Elavon Virtual Merchant is a payment solution.</p>
            * paypal_pro - <p class="mb-2">PayPal Pro Account is a payment gateway.</p>
            * orbital - <p class="mb-2">Chase Paymentech(Orbital) is a payment gateway.</p>
            * paypal - <p class="mb-2">PayPal Commerce is a payment gateway.</p>
            * beanstream - <p class="mb-2">Bambora(formerly known as Beanstream) is a payment gateway.</p>
            * hdfc - <p class="mb-2">HDFC Account is a payment gateway.</p>
            * ingenico_direct - <p class="mb-2">Worldline Online Payments is a payment gateway.</p>
            * ogone - <p class="mb-2">Ingenico ePayments (formerly known as Ogone) is a payment gateway.</p>
            * migs - <p class="mb-2">MasterCard Internet Gateway Service payment gateway.</p>
            * stripe - <p class="mb-2">Stripe is a payment gateway.</p>
            * vantiv - <p class="mb-2">Vantiv is a payment gateway.</p>
            * moneris - <p class="mb-2">Moneris is a payment gateway.</p>
            * bank_of_america - <p class="mb-2">Bank of America Gateway</p>
            * chargebee - <p class="mb-2">Chargebee test gateway.</p>
            * eway_rapid - <p class="mb-2">eWAY Rapid is a payment gateway.</p>
            * gocardless - <p class="mb-2">GoCardless is a payment service provider.</p>
            * mollie - <p class="mb-2">Mollie is a payment gateway.</p>
            * paymill - <p class="mb-2">PAYMILL is a payment gateway.</p>
            * balanced_payments - <p class="mb-2">Balanced is a payment gateway</p>
            * solidgate - <p class="mb-2">Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses.</p>
            <div class="alert alert-info"><p class="mb-2">This feature is a <strong class="font-semibold">Private Beta Release</strong>.</p></div>
            * cybersource - <p class="mb-2">CyberSource is a payment gateway.</p>
            * ebanx - <p class="mb-2">EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.</p>
            <span featureId="cb-ebanx" isMicro="true"></span>
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        payload:
          type: string
          deprecated: false
          description: |
            Payload from the gateway response with voucher details
          maxLength: 65000
          example: null
        error_code:
          type: string
          deprecated: false
          description: |
            Error code received from the payment gateway on failure.
          maxLength: 100
          example: null
        error_text:
          type: string
          deprecated: false
          description: |
            Error message received from the payment gateway on failure.
          maxLength: 65000
          example: null
        url:
          type: string
          deprecated: false
          description: |
            Chargebee Hosted Page url for payment voucher
          maxLength: 65000
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates when this payment voucher occurred date.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this voucher was last updated.
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        linked_invoices:
          type: array
          deprecated: false
          description: |
            Invoices related to the generated voucher
          items:
            type: object
            deprecated: false
            properties:
              invoice_id:
                type: string
                deprecated: false
                description: |
                  Identifier for the invoice.
                maxLength: 50
                example: null
              txn_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the payment voucher.
                maxLength: 40
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp at which the transaction is applied.
                example: null
            required:
            - applied_at
            - invoice_id
            - txn_id
            example: null
          example: null
      required:
      - currency_code
      - customer_id
      - gateway
      - id
      - payment_voucher_type
      example: null
    PaymentVoucherType:
      type: string
      deprecated: false
      enum:
      - boleto
      example: null
    Pc2Migration:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - initiated
          - data_transfer_started
          - data_transfer_completed
          - migration_completed
          - failed
          - draft_items_step_1_started
          - draft_items_step_1_completed
          - draft_item_families_step_2_completed
          - id_correction_step_3_completed
          - pc1_to_draft_model_started
          example: null
        current_action:
          type: string
          deprecated: false
          enum:
          - prepare_draft_data
          - autocorrect_invalid_and_duplicate_ids
          - enable_site_settings
          - transfer_custom_field
          - transfer_item_family
          - transfer_item
          - transfer_coupon
          - enable_pc2_site_setting
          - no_pending_action
          - contact_support
          - clear_sandbox_stale_ms_data
          - transfer_attached_item
          - map_pc1_data_to_draft_items
          example: null
        status_details:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        error_details:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        api_hit_count:
          type: integer
          format: int32
          default: 0
          deprecated: false
          example: null
        is_internal_migration:
          type: boolean
          default: false
          deprecated: false
          example: null
        is_id_processor_applicable:
          type: boolean
          default: false
          deprecated: false
          example: null
        is_attached_item_processor_applicable:
          type: boolean
          default: false
          deprecated: false
          example: null
        started_by:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        data_transfer_started_by:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        migration_completed_by:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        started_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        data_transfer_completed_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        migration_completed_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - id
      - started_at
      - status
      example: null
    Pc2MigrationApplicableItem:
      type: object
      properties:
        pc1_plan_code:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc1_plan_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc1_addon_code:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc2_addon_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc2_plan_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc2_plan_code:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        event_type:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      example: null
    Pc2MigrationItem:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc2_migration_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc2_migration_item_family_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc1_type:
          type: string
          deprecated: false
          enum:
          - plan
          - addon
          example: null
        is_recurring:
          type: boolean
          default: true
          deprecated: false
          example: null
        is_shippable:
          type: boolean
          default: false
          deprecated: false
          example: null
        is_giftable:
          type: boolean
          default: false
          deprecated: false
          example: null
        redirect_url:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        enabled_for_checkout:
          type: boolean
          default: false
          deprecated: false
          example: null
        enabled_in_portal:
          type: boolean
          default: false
          deprecated: false
          example: null
        gift_claim_redirect_url:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        unit:
          type: string
          deprecated: false
          maxLength: 30
          example: null
        included_in_mrr:
          type: boolean
          deprecated: false
          example: null
        description:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        metadata:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - draft
          - completed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - id
      - is_recurring
      - name
      - pc1_type
      - pc2_migration_id
      - status
      example: null
    Pc2MigrationItemFamily:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc2_migration_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        is_default:
          type: boolean
          default: false
          deprecated: false
          example: null
        metadata:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - draft
          - completed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - id
      - is_default
      - name
      - pc2_migration_id
      - status
      example: null
    Pc2MigrationItemPrice:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc2_migration_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        pc2_migration_item_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        ref_entity_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        pc1_item_type:
          type: string
          deprecated: false
          enum:
          - plan
          - addon
          example: null
        is_recurring:
          type: boolean
          default: true
          deprecated: false
          example: null
        is_primary_attached_item:
          type: boolean
          default: false
          deprecated: false
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 5
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          example: null
        period_unit:
          type: string
          deprecated: false
          enum:
          - day
          - week
          - month
          - year
          - not_applicable
          example: null
        is_invalid_pc1_id:
          type: boolean
          default: false
          deprecated: false
          example: null
        sanitized_pc1_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        metadata:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - draft
          - completed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - currency_code
      - id
      - is_invalid_pc1_id
      - is_primary_attached_item
      - is_recurring
      - name
      - pc2_migration_id
      - pc2_migration_item_id
      - status
      example: null
    PdfType:
      type: string
      default: detailed
      deprecated: true
      enum:
      - consolidated
      - detailed
      - changes_only
      example: null
    PendingInvoiceCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PendingInvoiceUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PeriodUnit:
      type: string
      deprecated: false
      enum:
      - day
      - week
      - month
      - year
      example: null
    PersonalizedOffer:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">A Personalized Offer represents the best possible offer for a subscriber at a given moment in their lifecycle. It is generated by combining subscriber profile, subscription details, and contextual signals with the plays configured by Growth Managers in the Chargebee Growth dashboard. Learn more about <a href="https://www.chargebee.com/docs/retention/getting-started-guide/chargebee-growth-solutions">Growth Solutions</a>.
        Growth Managers define strategic plays that guide customer engagement. Developers then use the Personalized Offers API to fetch and surface these offers within the subscriber experience; whether in an app, portal, checkout flow, websites or communications like email and SMS. Some common plays include:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Acquire</code>: Incentivize trial users or prospects to subscribe.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Expand</code>: Encourage existing subscribers to purchase higher-value products or add-ons.</li>
        <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Retain</code>: Engage at-risk subscribers with targeted winbacks or discounts.</li>
        </ul><p class="mb-2"><strong class="font-semibold">Note:</strong> Growth solutions are currently in <strong class="font-semibold">Early Access</strong> and available only for Chargebee Billing customers at no additional cost during the EAP period. This API is also part of the Early Access Program (EAP). To request access, go to the <a href="https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/chargebee-growth&amp;ref=feature">Chargebee Growth Early Access</a> page in Chargebee Billing.</p><p class="mb-2"><strong class="font-semibold">Features of this object</strong></p><p class="mb-2">The Personalized Offers object enables you to:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Fetch context-aware offers generated by the Growth system.</li>
        <li class="text-base leading-relaxed">Display offer content (title and description) to subscribers.</li>
        <li class="text-base leading-relaxed">Provide subscribers with options they can act on.</li>
        <li class="text-base leading-relaxed">Attribute offers to the correct brand (for multi-brand merchants).</li>
        <li class="text-base leading-relaxed">Respect time-bound validity with the expires_at attribute.</li>
        </ul></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the personalized offer.
          maxLength: 50
          example: null
        offer_id:
          type: string
          deprecated: false
          description: |
            ID of the base offer configured. This ID is immutable and always refers to the core offer and its latest published version.
          maxLength: 50
          example: null
        content:
          type: object
          deprecated: false
          description: |
            The offer content to display to the user, includes title \\\& description.
          properties:
            title:
              type: string
              deprecated: false
              description: |
                The offer headline to display to the end user.
              maxLength: 100
              example: null
            description:
              type: string
              deprecated: false
              description: |
                The offer content or description.
              maxLength: 100
              example: null
          required:
          - description
          - title
          example: null
        options:
          type: array
          deprecated: false
          description: |
            List of offer options (choices or call-to-action buttons) in this offer.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for a specific option within the offer.
                maxLength: 50
                example: null
              label:
                type: string
                deprecated: false
                description: |
                  The text to display on the call-to-action button or link for this option.
                maxLength: 50
                example: null
              processing_type:
                type: string
                deprecated: false
                description: |
                  The processing mode of the option. Possible values: billing_update, checkout, url_redirect, webhook, email. This indicates how the offer option is fulfilled: e.g., a direct billing change, a checkout flow, or a redirect to a URL.
                  \* email -

                  Chargebee sends an email as configured in the Growth application and the fulfillment is processed by merchant's system
                  \* checkout -

                  The offer fulfillment is processed using Chargebee hosted checkout
                  \* webhook -

                  Chargebee triggers webhook and fulfillment is processed by merchant's system
                  \* url_redirect -

                  The offer fulfillment is processed by merchant's system
                  \* billing_update -

                  The offer fulfillment is processed by Chargebee
                enum:
                - billing_update
                - checkout
                - url_redirect
                - webhook
                - email
                example: null
              processing_layout:
                type: string
                deprecated: false
                description: |
                  Indicated the suggested UI flow for checkout type offers. Possible values: in_app or full_page.
                  \* in_app -

                  Use an embedded checkout experience within the current interface.
                  \* full_page -

                  Redirect the user to a dedicated full-page checkout.
                enum:
                - in_app
                - full_page
                example: null
              redirect_url:
                type: string
                deprecated: false
                description: |
                  A URL to which the user should be redirected. Returned only if the offer's processing type is 'url_redirect'
                maxLength: 250
                example: null
            required:
            - id
            - label
            - processing_layout
            - processing_type
            - redirect_url
            example: null
          example: null
      required:
      - content
      - id
      - offer_id
      - options
      example: null
    Plan:
      type: object
      additionalProperties: true
      description: |
        Specifies the price with billing frequency for a subscription. Create separate plans for varied price or billing frequency. For example, if you need to charge $10 per month for a group of customers and $100 per year for another group of customers, then create separate plans for each.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique ID for your system to identify the plan.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name used in web interface for identifying the plan.
          maxLength: 100
          example: null
        invoice_name:
          type: string
          deprecated: false
          description: |
            Display name used in invoice. If it is not configured then name is used in invoice.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description about the plan to show in the hosted pages \& customer portal.
            **Note:**

            If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
          maxLength: 2000
          example: null
        price:
          type: integer
          format: int64
          deprecated: false
          description: |
            The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the plan
          maxLength: 3
          example: null
        period:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
          minimum: 1
          example: null
        period_unit:
          type: string
          default: month
          deprecated: false
          description: |
            Defines billing frequency in association with billing period.
            \* month -

            Charge based on month(s)
            \* day -

            Charge based on day(s)
            \* week -

            Charge based on week(s)
            \* year -

            Charge based on year(s)
          enum:
          - day
          - week
          - month
          - year
          example: null
        trial_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The free time window for your customer to try your product
          minimum: 1
          example: null
        trial_period_unit:
          type: string
          deprecated: false
          description: |
            Time unit for the trial period.
            \* month -

            In months
            \* day -

            In days
          enum:
          - day
          - month
          example: null
        trial_end_action:
          type: string
          deprecated: false
          description: |
            Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            has been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)
            .
            \* cancel_subscription -

            The subscription cancels.
            \* activate_subscription -

            The subscription activates and charges are raised for non-metered items.
            \* site_default -

            The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            at the time when the trial ends, takes effect.
          enum:
          - site_default
          - activate_subscription
          - cancel_subscription
          example: null
        pricing_model:
          type: string
          default: flat_fee
          deprecated: false
          description: |
            Defines how the recurring charges for the subscription is calculated.
            \* tiered -

            There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
            \* per_unit -

            A fixed price per unit quantity.
            \* flat_fee -

            A fixed price that is not quantity-based.
            \* volume -

            The per unit price is based on the tier that the total quantity falls in.
            \* stairstep -

            A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
          enum:
          - flat_fee
          - per_unit
          - tiered
          - volume
          - stairstep
          example: null
        free_quantity:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: |
            Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.
          minimum: 0
          example: null
        setup_cost:
          type: integer
          format: int64
          deprecated: false
          description: |
            One-time setup fee charged as part of the first invoice.
          minimum: 1
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |
            The plan state
            \* archived -

            No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required.
            \* active -

            New subscriptions can be created with the plan.
            \* deleted -

            Indicates the plan has been deleted.
          enum:
          - active
          - archived
          - deleted
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time at which the plan was moved to archived status.
          example: null
        billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |
            The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically
          minimum: 1
          example: null
        redirect_url:
          type: string
          deprecated: false
          description: |
            The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic
          maxLength: 500
          example: null
        enabled_in_hosted_pages:
          type: boolean
          default: true
          deprecated: false
          description: |
            If true, allow checkout through plan specific hosted page URL for this plan.
          example: null
        enabled_in_portal:
          type: boolean
          default: true
          deprecated: false
          description: |
            If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.
          example: null
        addon_applicability:
          type: string
          default: all
          deprecated: false
          description: |
            Indicates if all or only some addons are applicable with the plan.
            \* all -

            All addons are applicable with this plan.
            \* restricted -

            Only addons marked as 'applicable_addons' are applicable with the plan.
          enum:
          - all
          - restricted
          example: null
        tax_code:
          type: string
          deprecated: false
          description: |
            The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)
            .
          maxLength: 50
          example: null
        hsn_code:
          type: string
          deprecated: false
          description: |
            The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
            to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

            * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
            * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
          maxLength: 50
          example: null
        taxjar_product_code:
          type: string
          deprecated: false
          description: |
            The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)
            .
          maxLength: 50
          example: null
        avalara_sale_type:
          type: string
          deprecated: false
          description: |
            Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
            \* retail -

            Transaction is a sale to an end user
            \* vendor_use -

            Transaction is for an item that is subject to vendor use tax
            \* consumed -

            Transaction is for an item that is consumed directly
            \* wholesale -

            Transaction is a sale to another company that will resell your product or service to another consumer
          enum:
          - wholesale
          - retail
          - consumed
          - vendor_use
          example: null
        avalara_transaction_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
          example: null
        avalara_service_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
            integration.
          example: null
        sku:
          type: string
          deprecated: false
          description: |
            The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
          maxLength: 100
          example: null
        accounting_code:
          type: string
          deprecated: false
          description: |
            This field is to capture the Account code setup in your Accounting system for integration purposes only.
          maxLength: 100
          example: null
        accounting_category1:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category2:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category3:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/1.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/1.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.</li>
            </ul>
          maxLength: 100
          example: null
        accounting_category4:
          type: string
          deprecated: false
          description: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

            * [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
            * [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product.
          maxLength: 100
          example: null
        is_shippable:
          type: boolean
          default: false
          deprecated: false
          description: |
            If enabled, charges for this plan/addon will be added to orders.
          example: null
        shipping_frequency_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
          minimum: 1
          example: null
        shipping_frequency_period_unit:
          type: string
          deprecated: false
          description: |
            Defines the shipping frequency in association with shipping period.
            \* month -

            Ship based on month(s)
            \* year -

            Ship based on year(s)
            \* day -

            Ship based on day(s)
            \* week -

            Ship based on week(s)
          enum:
          - year
          - month
          - week
          - day
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this plan was last updated. This attribute will be present only if the resource has been updated after 2016-11-09.
          example: null
        giftable:
          type: boolean
          default: false
          deprecated: false
          description: |
            Specifies if the plan should be gifted or not.
          example: null
        claim_url:
          type: string
          deprecated: false
          description: |
            The url to redirect on successful claim. Eg: https://yoursite.com/claim_success.html?plan=basic
          maxLength: 500
          example: null
        free_quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 33
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The price of the plan when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
            When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
            is enabled.</p>
          maxLength: 39
          example: null
        channel:
          type: string
          deprecated: false
          description: |
            The subscription channel this object originated from and is maintained in.
            \* web -

            The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
            \* app_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.
            \* play_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
          enum:
          - web
          - app_store
          - play_store
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)
            displayed on the invoice PDF.
          maxLength: 2000
          example: null
        taxable:
          type: boolean
          default: true
          deprecated: false
          description: |
            Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)
            have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
          example: null
        tax_profile_id:
          type: string
          deprecated: false
          description: |
            Tax profile of the plan.
          maxLength: 50
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the plan. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
        show_description_in_invoices:
          type: boolean
          default: false
          deprecated: false
          description: |-
            <p class="mb-2">Whether the <code><a href="/docs/api/v2/pcv-1/plans/plan-object">plan.description</a></code>
            should be shown on <a href="/docs/api/invoices/retrieve-invoice-as-pdf">invoice PDFs</a>.
            If this Boolean is changed, only invoices generated (or <a href="https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">regenerated</a>
            )after the change are affected; past invoices are not.</p>
          example: null
        show_description_in_quotes:
          type: boolean
          default: false
          deprecated: false
          description: |
            Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)
            should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).
            If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
          example: null
        tiers:
          type: array
          deprecated: false
          description: |
            List of tiers for this plan(applicable only if it is tiered/volume/stairtstep pricing)
          items:
            type: object
            deprecated: false
            properties:
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |-
                  <p class="mb-2">The per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  ; the total cost for the item price when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>.
                  The value is in the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">minor unit of the currency</a>
                  .</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - price
            - starting_unit
            example: null
          example: null
        tax_providers_fields:
          type: array
          deprecated: false
          description: |
            List of vendor specific tax related information.
          items:
            type: object
            deprecated: false
            properties:
              provider_name:
                type: string
                deprecated: false
                description: |
                  Name of the tax provider currently we support.
                maxLength: 50
                example: null
              field_id:
                type: string
                deprecated: false
                description: |
                  Field id of the attribute which tax vendor has provided while getting onboarded with us.
                maxLength: 50
                example: null
              field_value:
                type: string
                deprecated: false
                description: |
                  The value of the corresponding tax field.
                maxLength: 50
                example: null
            required:
            - field_id
            - field_value
            - provider_name
            example: null
          example: null
        applicable_addons:
          type: array
          deprecated: false
          description: |
            List of addons applicable with this plan.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon appplicable to the plan.
                maxLength: 100
                example: null
            required:
            - id
            example: null
          example: null
        attached_addons:
          type: array
          deprecated: false
          description: |
            Indicates if the addon is attached with the plan as mandatory or recommended.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of billing cycles this addon will be attached to the plan.
                minimum: 1
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  Specifies attachment type of the addon to the plan
                  \* recommended -

                  Addon will be charged with this plan unless specifically removed.
                  \* mandatory -

                  Addon will be always charged with this plan.
                enum:
                - recommended
                - mandatory
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
            required:
            - id
            - quantity
            - type
            example: null
          example: null
        event_based_addons:
          type: array
          deprecated: false
          description: |
            List of addons that will be charged on occurrence of specific event on subscribing to the plan.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon. Multiple addons can be passed.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              on_event:
                type: string
                deprecated: false
                description: |
                  Event on which the addon will be charged
                  \* plan_activation -

                  Addon will be charged on plan activation.
                  \* contract_termination -

                  Addon will be charged on contract termination.
                  \* subscription_activation -

                  Addon will be charged on subscription activation.
                  \* subscription_creation -

                  Addon will be charged on subscription creation.
                  \* subscription_trial_start -

                  Addon will be charged when the trial period starts.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                default: true
                deprecated: false
                description: |
                  If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
            required:
            - charge_once
            - id
            - on_event
            - quantity
            example: null
          example: null
      required:
      - addon_applicability
      - currency_code
      - enabled_in_hosted_pages
      - enabled_in_portal
      - free_quantity
      - giftable
      - id
      - name
      - period
      - period_unit
      - pricing_model
      - status
      example: null
    PlanCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            plan:
              $ref: "#/components/schemas/Plan"
          required:
          - plan
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PlanDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            plan:
              $ref: "#/components/schemas/Plan"
          required:
          - plan
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PlanUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            plan:
              $ref: "#/components/schemas/Plan"
          required:
          - plan
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PortalSession:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">Customer Portal lets your customers to manage their account and billing themselves. Chargebee supports Single Sign-on (SSO) to access the customer portal. If you already have your own authentication for your website, it allows your authenticated customers to access their portal without having to login again.</p><p class="mb-2"><strong class="font-semibold">Note:</strong> You can instead allow your customers to access the portal via login page provided by Chargebee. <a href="https://www.chargebee.com/docs/1.0/customer_portal.html#how-can-customers-access-their-customer-account-portal" target="_blank">Read more</a>.</p><p class="mb-2">Please follow the below steps for supporting portal access via SSO:</p><ol class="list-decimal list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">Enable the &quot;Allow access to customer portal via API&quot; under &quot;Settings &gt; Hosted Pages Settings &gt; Customer Portal&quot; to use the portal sessions API.</li>
        <li class="text-base leading-relaxed">Provide a link in your website/application which your authenticated customers can use to access the portal (For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">{your_website_url}/portal_link</code>).</li>
        <li class="text-base leading-relaxed">Handle the link request in your server code and create a portal session for the customer by calling Chargebee&#x27;s &quot;Create a portal session&quot; API</li>
        <li class="text-base leading-relaxed">Forward the user to the access URL present in the &quot;Portal Session&quot; resource returned by the above API call.</li>
        </ol><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Notes about access URL:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">The access URL should be accessed by the customer within one hour from the time it was created.</li>
        <li class="text-base leading-relaxed">Once accessed, the session is valid until the user logs out from the portal UI or logout API is called from your application for this session.</li>
        <li class="text-base leading-relaxed">Once accessed, the access url cannot be reused. Hence do not persist this URL. Whenever you need to provide access to the portal, you need to create a new portal session.</li>
        </ul></div><h4>Using Chargebee&#x27;s authentication</h4><p class="mb-2"><strong class="font-semibold">Note:</strong> This feature is not supported in <a href="https://www.chargebee.com/docs/inapp-self-serve-portal.html" target="_blank">in-app</a> portal.
        Chargebee allows you to integrate your website by building user authentication on top of Chargebee. You can also use the portal login to provide authenticated access for your customers to your website pages.
        <strong class="font-semibold">Workflow:</strong>
        Users should be redirected to the portal login URL - <strong class="font-semibold">https://yourdomain.chargebeeportal.com/portal/login</strong> by passing the following parameters:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">return_url</strong> - URL the users should be redirected to upon successful authentication.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">cancel_url</strong> - URL the users should be redirected to when they want to go back to your website during login.
        The domain name used in the Return/Cancel URL should be added as a &#x27;Whitelisted Domain&#x27; in Chargebee. Add just the domain name in Chargebee and not the entire URL: E.g. yourdomain.com.</li>
        </ul><p class="mb-2">Upon successful authentication, a session is created for the user and Chargebee redirects the user to the return_url along with the following parameters:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed"><strong class="font-semibold">auth_session_id</strong> - Identifier to the authenticated session.</li>
        <li class="text-base leading-relaxed"><strong class="font-semibold">auth_session_token</strong> - Token for the session which should be sent later to activate this session.
        Using the <strong class="font-semibold">auth_session_id</strong> &amp; <strong class="font-semibold">auth_session_token</strong>, you should call <a href="/docs/api/v2/pcv-1/portal_sessions/activate-a-portal-session">Activate a Portal Session</a> API to validate the session details and create a session for that user in your website.
        <strong class="font-semibold">Note:</strong> The process of setting up the portal account will take place along with the authentication process.</li>
        </ul></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier for the portal session.
          maxLength: 70
          example: null
        token:
          type: string
          deprecated: false
          description: |
            Unique pre-authenticated portal session token to access customer portal directly.
          maxLength: 70
          example: null
        access_url:
          type: string
          deprecated: false
          description: |
            Unique URL for accessing the customer portal. Once accessed, this cannot be reused.
          maxLength: 550
          example: null
        redirect_url:
          type: string
          deprecated: false
          description: |
            URL to redirect when the user logs out from the portal.
          maxLength: 250
          example: null
        status:
          type: string
          default: created
          deprecated: false
          description: |
            Indicates the current status of the portal session.
            \* created -

            Indicates that the portal session is just created and not yet accessed by the user.
            \* logged_out -

            Indicates that the portal session is logged out either by user or via API.
            \* not_yet_activated -

            Indicates that the portal session is created and not yet activated for the customer to allow access to your website. This is applicable when you use Chargebee's authentication for your website
            \* activated -

            Indicates that the portal session is activated for the customer to allow access to your website. This is applicable when you use Chargebee's authentication for your website.
            \* logged_in -

            Indicates that the portal session URL has been accessed by the user and the session is active.
          enum:
          - created
          - logged_in
          - logged_out
          - not_yet_activated
          - activated
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this portal session was generated.
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies when the portal session URL expires. After this time, it is no longer accessible. The expiration time is set to 1 hour after the portal session is created.
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        login_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this portal session URL was accessed by the user.
          example: null
        logout_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this portal session was logged out either by user or via API.
          example: null
        login_ipaddress:
          type: string
          deprecated: false
          description: |
            IP Address from which the portal session URL was accessed.
          maxLength: 50
          example: null
        logout_ipaddress:
          type: string
          deprecated: false
          description: |
            IP Address from which the portal session was logged out either by user or via API.
          maxLength: 50
          example: null
        linked_customers:
          type: array
          deprecated: false
          description: |
            The list of customers for this session
          items:
            type: object
            deprecated: false
            properties:
              customer_id:
                type: string
                deprecated: false
                description: |
                  Identifier of the customer.
                maxLength: 50
                example: null
              email:
                type: string
                format: email
                deprecated: false
                description: |
                  Email of the customer. Configured email notifications will be sent to this email.
                maxLength: 70
                example: null
              has_billing_address:
                type: boolean
                default: false
                deprecated: false
                description: |
                  The customer has billing address.
                example: null
              has_payment_method:
                type: boolean
                default: false
                deprecated: false
                description: |
                  The customer has payment method.
                example: null
              has_active_subscription:
                type: boolean
                default: false
                deprecated: false
                description: |
                  The customer has atleast one active subscription.
                example: null
            required:
            - customer_id
            - has_active_subscription
            - has_billing_address
            - has_payment_method
            example: null
          example: null
      required:
      - access_url
      - created_at
      - customer_id
      - id
      - status
      - token
      example: null
    PriceType:
      type: string
      default: tax_exclusive
      deprecated: false
      enum:
      - tax_exclusive
      - tax_inclusive
      example: null
    PricingModel:
      type: string
      deprecated: false
      enum:
      - flat_fee
      - per_unit
      - tiered
      - volume
      - stairstep
      example: null
    PricingPageSession:
      type: object
      description: |
        **Important:**
        This recource does not support product catalog 1.0. Navigate to the correct [version](/docs/api/pricing_page_sessions).
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier generated for each pricing page session requested.
          maxLength: 70
          example: null
        url:
          type: string
          deprecated: false
          description: |
            Unique URL for the pricing page that will be included in your website.
          maxLength: 250
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates when this pricing page session is generated.
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates when this pricing page session will expire. After this, the pricing page cannot be accessed.
          example: null
      example: null
    PricingType:
      type: string
      deprecated: false
      enum:
      - per_unit
      - flat_fee
      - package
      example: null
    ProductCatalogVersion:
      type: string
      deprecated: false
      enum:
      - v1
      - v2
      example: null
    PromotionalCredit:
      type: object
      description: |
        These credits can be provided to the customer for promoting the product. You can use Promotional Credits to offer referral bonuses, cash back offers and more. When a customer has promotional credits, it is automatically applied whenever a new invoice is created.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique reference ID provided for promotional credits
          maxLength: 150
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        type:
          type: string
          deprecated: false
          description: |
            Type of promotional credits
            \* decrement -

            Decrement
            \* increment -

            Increment
          enum:
          - increment
          - decrement
          example: null
        amount_in_decimal:
          type: string
          deprecated: false
          description: |
            Amount in decimal
          maxLength: 33
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Promotional credits amount
          minimum: 0
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for promotional credit
          maxLength: 3
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Detailed description of this promotional credits.
          maxLength: 250
          example: null
        credit_type:
          type: string
          default: general
          deprecated: false
          description: |
            Type of promotional credits provided to customer
            \* referral_rewards -

            Referral
            \* loyalty_credits -

            Loyalty Credits
            \* general -

            General
          enum:
          - loyalty_credits
          - referral_rewards
          - general
          example: null
        reference:
          type: string
          deprecated: false
          description: |
            Describes why promotional credits were provided
          maxLength: 500
          example: null
        closing_balance:
          type: integer
          format: int64
          deprecated: false
          description: |
            Closing balance as on end date.
          minimum: 0
          example: null
        done_by:
          type: string
          deprecated: false
          description: |
            The user who added/deducted the credit. If created via API, this contains the name given for the API key used.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this promotional credit resource is created.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      required:
      - amount
      - closing_balance
      - created_at
      - credit_type
      - currency_code
      - customer_id
      - description
      - id
      - type
      example: null
    PromotionalCreditsAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            promotional_credit:
              $ref: "#/components/schemas/PromotionalCredit"
          required:
          - customer
          - promotional_credit
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PromotionalCreditsDeductedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            promotional_credit:
              $ref: "#/components/schemas/PromotionalCredit"
          required:
          - customer
          - promotional_credit
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ProrationType:
      type: string
      deprecated: false
      enum:
      - full_term
      - partial_term
      - none
      example: null
    Quote:
      type: object
      additionalProperties: true
      description: |
        A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it.

        The line items of a quote are grouped by charge events and are available as a separate [resource](/docs/api/quote_line_groups). This resource can be retrieved using the [List quote line groups](/docs/api/quotes/list-quote-line-groups) endpoint. Note that the first quote line group is available within the quote resource itself and parsing the quote line groups object is not required.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The quote number. Acts as a identifier for quote and typically generated sequentially.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The quote name will be used as the pdf name of the quote.
          maxLength: 100
          example: null
        po_number:
          type: string
          deprecated: false
          description: |
            Purchase Order Number
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The identifier of the customer this quote belongs to.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The identifier of the subscription this quote belongs to.
          maxLength: 50
          example: null
        invoice_id:
          type: string
          deprecated: false
          description: |
            The identifier of the invoice generated while converting this quote.
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of this quote.
            \* open -

            Open
            \* invoiced -

            Invoiced
            \* accepted -

            Accepted.
            \* closed -

            Closed
            \* declined -

            Declined.
          enum:
          - open
          - accepted
          - declined
          - invoiced
          - closed
          - pending_approval
          - approval_rejected
          - proposed
          - voided
          - expired
          example: null
        operation_type:
          type: string
          deprecated: false
          description: |
            Operation Type
            \* onetime_invoice -

            onetime_invoice
            \* create_subscription_for_customer -

            create_subscription_for_customer
            \* change_subscription -

            change_subscription
          enum:
          - create_subscription_for_customer
          - change_subscription
          - onetime_invoice
          - renew_subscription
          example: null
        vat_number:
          type: string
          deprecated: false
          description: |
            VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)
          maxLength: 20
          example: null
        price_type:
          type: string
          default: tax_exclusive
          deprecated: false
          description: |
            The price type of the quote.
            \* tax_inclusive -

            All amounts in the document are inclusive of tax.
            \* tax_exclusive -

            All amounts in the document are exclusive of tax.
          enum:
          - tax_exclusive
          - tax_inclusive
          example: null
        valid_till:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Quote will be valid till this date. After this date quote will be marked as closed.
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Creation date of the quote. Typically this is the date on which quote is generated.
          example: null
        total_payable:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total contract value. Applicable when multi billing cycle quote is enabled.
          minimum: 0
          example: null
        charge_on_acceptance:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Charge on acceptance. Applicable when multi billing cycle quote is enabled.
          minimum: 0
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          description: |
            Subtotal (in cents) of the first quote line group.
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Total (in cents) of the first quote line group.
          minimum: 0
          example: null
        credits_applied:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Credits applied (in cents) for the first quote line group.
          minimum: 0
          example: null
        amount_paid:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Existing outstanding payments (in cents) if any, applied to the first quote line group.
          minimum: 0
          example: null
        amount_due:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Amount due (in cents) for the first quote line group.
          minimum: 0
          example: null
        version:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Version of the quote.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this quote was last updated.
          example: null
        vat_number_prefix:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>.
            Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong>
            ).</p>
            <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a>
            in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a>
            the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p>
            <p class="mb-2"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>
            as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>.
            That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>.
            The first two characters of the VAT number in such a case is
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>
            by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>.
            Set
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code>
            to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>
            for such cases.</p>
          maxLength: 10
          example: null
        tax_category:
          type: string
          deprecated: false
          description: |
            Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the quote.
          maxLength: 3
          example: null
        notes:
          type: array
          deprecated: false
          description: |
            List of notes associated with this quotes.
          items:
            example: null
          example: null
        contract_term_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies the contract term's start date.
          example: null
        contract_term_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Specifies the contract term&#x27;s end date. It indicates when the action set in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code>
            gets triggered.</p>
          example: null
        contract_term_termination_fee:
          type: integer
          format: int64
          deprecated: false
          description: |
            Specifies the charge to be applied for terminating the contract term.
          minimum: 0
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Indicates that this resource has been deleted when the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            .</p>
          example: null
        total_contract_value:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        total_discount:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            The list of line items for this quote.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the subscription this line item belongs to.
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of this line item.
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of this line item.
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Unit amount of the line item.
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |
                  [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item.
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of this line item. Typically equals to unit amount x quantity
                example: null
              pricing_model:
                type: string
                deprecated: false
                description: |
                  The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                  for this item.
                  \* stairstep -

                  A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  \* flat_fee -

                  A fixed price that is not quantity-based.
                  \* tiered -

                  There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                  \* per_unit -

                  A fixed price per unit quantity.
                  \* volume -

                  The per unit price is based on the tier that the total quantity falls in.
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Specifies whether this line item is taxed or not
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The tax amount charged for this item
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                description: |
                  Rate of tax used to calculate tax for this lineitem
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                  x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                  Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total discounts for this line
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Line Item-level discounts for this line.
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                description: |
                  Invoice Reference Line Item ID
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this line item.
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this item.
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this line item is based on.
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                  * zero_value_item - <p class="mb-2">If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.</p>
                  * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                  * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                  * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                  * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                  * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                  * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                  * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                  * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                  and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                  have not been provided for the customer and subscription respectively</p>
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this line item belongs to
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_tiers:
          type: array
          deprecated: false
          description: |
            The list of tiers applicable for the various line items in this quote.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of units purchased in a range.
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                  pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  pricing.</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          description: |
            The list of deductions applied for each line item of this quote.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique id of the line item that this deduction is for.
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case.</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a coupon, then this is the id of the coupon.
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied on the line items of this quote.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the tax is applicable
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The rate of tax used to calculate tax amount
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period end of the tax rate for the line item.
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates the service period start of the tax rate for the line item.
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Indicates the prorated line item amount in cents.
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                description: |
                  Indicates if tax is applied only on a portion of the line item amount.
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                description: |
                  Indicates the non-compliance tax that should not be reported to the jurisdiction.
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Indicates the actual portion of the line item amount that is taxable.
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                description: |
                  The type of tax jurisdiction
                  \* federal -

                  The tax jurisdiction is a federal
                  \* state -

                  The tax jurisdiction is a state
                  \* county -

                  The tax jurisdiction is a county
                  \* country -

                  The tax jurisdiction is a country
                  \* city -

                  The tax jurisdiction is a city
                  \* special -

                  Special tax jurisdiction.
                  \* unincorporated -

                  Combined tax of state and county.
                  \* other -

                  Jurisdictions other than the ones listed above.
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax jurisdiction
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                description: |
                  The tax jurisdiction code
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            The list of all deductions applied to the quote.
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description for this deduction.
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                  .</p>
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice.</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">When the deduction is due to a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                  , then this is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  of the coupon.</p>
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                  , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                  is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applicable for this quote.
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied. E.g. GST.
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description of the tax item.
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
        shipping_address:
          type: object
          deprecated: false
          description: |
            Shipping address for the quote.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* not_validated -

                Address is not yet validated.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        billing_address:
          type: object
          deprecated: false
          description: |
            Billing address for the quote.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the billing contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the billing contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                State or Province
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
                \* not_validated -

                Address is not yet validated.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
      required:
      - currency_code
      - customer_id
      - date
      - deleted
      - id
      - operation_type
      - price_type
      - status
      - sub_total
      - valid_till
      example: null
    QuoteCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            quote:
              $ref: "#/components/schemas/Quote"
          required:
          - quote
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    QuoteDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            quote:
              $ref: "#/components/schemas/Quote"
          required:
          - quote
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    QuoteEntitlement:
      type: object
      properties:
        entity_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan_price
          - addon_price
          - charge_price
          - charge
          example: null
        feature_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        is_enabled:
          type: boolean
          default: true
          deprecated: false
          example: null
        start_date:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        end_date:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - feature_id
      - is_enabled
      - modified_at
      - value
      example: null
    QuoteLineGroup:
      type: object
      description: |
        The line items of a quote are grouped by charge event. Each of these groups is called a quote line group. A quote would have at least one quote line group. Let's look at an example.

        Consider the following:

        * A monthly plan A for $500 per month.
        * A non-recurring addon B for $50. Now consider a quote that is created for 3 billing cycles of the plan with the addon applied immediately. This quote would be associated with a list of quote line groups: one for each charge event as shown below:

        #### Quote Line group 1

        **Plan A:**
        $500

        **Addon B:**
        $50

        **Total:**
        $550

        #### Quote Line group 2

        **Plan A:**
        $500

        **Total:**
        $500

        #### Quote Line group 3

        **Plan A:**
        $500

        **Total:**
        $500
      properties:
        version:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Version of the quote line group.
          example: null
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies a quote line group.
          maxLength: 40
          example: null
        sub_total:
          type: integer
          format: int64
          deprecated: false
          description: |
            Subtotal in cents.
          minimum: 0
          example: null
        total:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Total in cents.
          minimum: 0
          example: null
        credits_applied:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Credits (in cents) applied to this quote line group.
          minimum: 0
          example: null
        amount_paid:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Existing outstanding payments (in cents) if any, applied to this quote line group.
          minimum: 0
          example: null
        amount_due:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            Amount due in cents
          minimum: 0
          example: null
        charge_event:
          type: string
          deprecated: false
          description: |
            Describes the time in the subscription lifecycle when the charge is to occur.
            \* subscription_creation -

            Subscription Creation
            \* trial_start -

            Trial Start
            \* subscription_renewal -

            Subscription Renewal
            \* subscription_change -

            Subscription Change
            \* subscription_cancel -

            Subscription Cancel
            \* immediate -

            Immediate
          enum:
          - immediate
          - subscription_creation
          - trial_start
          - subscription_change
          - subscription_renewal
          - subscription_cancel
          example: null
        billing_cycle_number:
          type: integer
          format: int32
          deprecated: false
          description: |
            The serial number of the billing cycle of which the quote line group is a part.
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            The list of items in this quote line group.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies a line_item
                maxLength: 40
                example: null
              subscription_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the subscription this line item belongs to.
                maxLength: 50
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of this line item.
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of this line item.
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Unit amount of the line item.
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |
                  [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item.
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of this line item. Typically equals to unit amount x quantity
                example: null
              pricing_model:
                type: string
                deprecated: false
                description: |
                  The
                  [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)
                  for this item.
                  \* per_unit -

                  A fixed price per unit quantity.
                  \* stairstep -

                  A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
                  \* flat_fee -

                  A fixed price that is not quantity-based.
                  \* tiered -

                  There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
                  \* volume -

                  The per unit price is based on the tier that the total quantity falls in.
                enum:
                - flat_fee
                - per_unit
                - tiered
                - volume
                - stairstep
                example: null
              is_taxed:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Specifies whether this line item is taxed or not
                example: null
              tax_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The tax amount charged for this item
                minimum: 0
                example: null
              tax_rate:
                type: number
                format: double
                deprecated: false
                description: |
                  Rate of tax used to calculate tax for this lineitem
                maximum: 100
                minimum: 0
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the unit amount of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity of this line_item. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the amount for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  , in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
                  x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
                  Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 39
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total discounts for this line
                minimum: 0
                example: null
              item_level_discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Line Item-level discounts for this line.
                minimum: 0
                example: null
              metered:
                type: boolean
                deprecated: false
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                description: |
                  Invoice Reference Line Item ID
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this line item.
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                description: |
                  Detailed description about this item.
                maxLength: 500
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modelled entity this line item is based on.
                  \* addon -

                  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
                  id
                  \* plan_item_price -

                  Indicates that this line item is based on plan Item Price
                  \* addon_item_price -

                  Indicates that this line item is based on addon Item Price
                  \* charge_item_price -

                  Indicates that this line item is based on charge Item Price
                  \* adhoc -

                  Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                  \* plan_setup -

                  Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                  \* plan -

                  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
                  id
                enum:
                - plan_setup
                - plan
                - addon
                - adhoc
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The reason due to which the line item price/amount is exempted from tax.</p>
                  * reverse_charge - <p class="mb-2">If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only</p>
                  * tax_not_configured - <p class="mb-2">If tax is not enabled for the site</p>
                  * high_value_physical_goods - <p class="mb-2">If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied</p>
                  * product_exempt - <p class="mb-2">If the Plan or Addon is marked as Tax exempt</p>
                  * zero_rated - <p class="mb-2">If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item</p>
                  * customer_exempt - <p class="mb-2">If the Customer is marked as Tax exempt</p>
                  * region_non_taxable - <p class="mb-2">If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction</p>
                  * export - <p class="mb-2">You are not registered for tax in the customer&#x27;s region. This is also the reason code when both <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code>
                  and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">shipping_address</code>
                  have not been provided for the customer and subscription respectively</p>
                enum:
                - tax_not_configured
                - region_non_taxable
                - export
                - customer_exempt
                - product_exempt
                - zero_rated
                - reverse_charge
                - high_value_physical_goods
                - zero_value_item
                - tax_not_configured_external_provider
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
                maxLength: 100
                example: null
              customer_id:
                type: string
                deprecated: false
                description: |
                  A unique identifier for the customer this line item belongs to
                maxLength: 100
                example: null
            required:
            - date_from
            - date_to
            - description
            - entity_type
            - is_taxed
            - unit_amount
            example: null
          example: null
        line_item_discounts:
          type: array
          deprecated: false
          description: |
            The list of discount(s) applied for line items in this quote line group.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique id of the line item that this deduction is for.
                maxLength: 50
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to a line item of the invoice. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case.</p>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a coupon, then this is the id of the coupon.
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              discount_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
            required:
            - discount_amount
            - discount_type
            - line_item_id
            example: null
          example: null
        line_item_taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied on line items in this quote line group.
          items:
            type: object
            deprecated: false
            properties:
              line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique reference id of the line item for which the tax is applicable
                maxLength: 40
                example: null
              tax_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied
                maxLength: 100
                example: null
              tax_rate:
                type: number
                format: double
                default: 0
                deprecated: false
                description: |
                  The rate of tax used to calculate tax amount
                maximum: 100
                minimum: 0
                example: null
              date_to:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              date_from:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              prorated_taxable_amount:
                type: number
                format: decimal
                deprecated: false
                maximum: 1000000000
                minimum: -1000000000
                example: null
              is_partial_tax_applied:
                type: boolean
                deprecated: false
                description: |
                  Indicates if tax is applied only on a portion of the line item amount.
                example: null
              is_non_compliance_tax:
                type: boolean
                deprecated: false
                description: |
                  Indicates the non-compliance tax that should not be reported to the jurisdiction.
                example: null
              taxable_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Indicates the actual portion of the line item amount that is taxable.
                minimum: 0
                example: null
              tax_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount
                minimum: 0
                example: null
              tax_juris_type:
                type: string
                deprecated: false
                description: |
                  The type of tax jurisdiction
                  \* unincorporated -

                  Combined tax of state and county.
                  \* federal -

                  The tax jurisdiction is a federal
                  \* state -

                  The tax jurisdiction is a state
                  \* county -

                  The tax jurisdiction is a county
                  \* country -

                  The tax jurisdiction is a country
                  \* city -

                  The tax jurisdiction is a city
                  \* other -

                  Jurisdictions other than the ones listed above.
                  \* special -

                  Special tax jurisdiction.
                enum:
                - country
                - federal
                - state
                - county
                - city
                - special
                - unincorporated
                - other
                example: null
              tax_juris_name:
                type: string
                deprecated: false
                description: |
                  The name of the tax jurisdiction
                maxLength: 250
                example: null
              tax_juris_code:
                type: string
                deprecated: false
                description: |
                  The tax jurisdiction code
                maxLength: 250
                example: null
              tax_amount_in_local_currency:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
                minimum: 0
                example: null
              local_currency_code:
                type: string
                deprecated: false
                description: |
                  The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
                maxLength: 3
                example: null
            required:
            - tax_amount
            - tax_name
            - tax_rate
            - taxable_amount
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            The list of discounts applied to this quote line group.
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description for this deduction.
                maxLength: 250
                example: null
              line_item_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The unique id of the line item that this deduction is for. Is required when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">discounts[entity_type]</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_level_coupon</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document_level_coupon</code>
                  .</p>
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The type of deduction and the amount to which it is applied.</p>
                  * document_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The coupon id is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * prorated_credits - <p class="mb-2">The deduction is due to a legacy adjustment credit applied to the invoice. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
                  in this case. The legacy credits feature is superseded by <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a></code>
                  .</p>
                  * item_level_coupon - <p class="mb-2">The deduction is due to a coupon applied to line item. The coupon <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is passed as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                  * item_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to a line item of the invoice. The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                  * promotional_credits - <p class="mb-2">The deduction is due to a <a href="/docs/api/promotional_credits">promotional credit</a>
                  applied to the invoice.</p>
                  * document_level_discount - <p class="mb-2">The deduction is due to a <a href="/docs/api/discounts">discount</a>
                  applied to the invoice <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sub_total</code>.
                  The discount <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>.</p>
                  <span featureId="cb-discounts" isMicro="true"></span>
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                example: null
              discount_type:
                type: string
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">When the deduction is due to a
                  <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">coupon</code>
                  , then this is the
                  <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
                  of the coupon.</p>
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The <a href="/docs/api/coupon_codes/coupon_code-object#code">coupon code</a>
                  , if applicable, used to provide the discount. The <a href="/docs/api/coupons/coupon-object#id">coupon.id</a>
                  is available in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_id</code>
                  .</p>
                maxLength: 50
                example: null
            required:
            - amount
            - entity_type
            example: null
          example: null
        taxes:
          type: array
          deprecated: false
          description: |
            The list of taxes applied to this quote line group.
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  The name of the tax applied. E.g. GST.
                maxLength: 100
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The tax amount.
                minimum: 0
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description of the tax item.
                maxLength: 250
                example: null
            required:
            - amount
            - name
            example: null
          example: null
      required:
      - sub_total
      example: null
    QuoteUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            quote:
              $ref: "#/components/schemas/Quote"
          required:
          - quote
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    QuotedCharge:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">When the
        <code><a href="/docs/api/quotes/quote-object#operation_type">operation_type</a></code>
        of a
        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quote</code>
        is
        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">onetime_invoice</code>
        , the
        <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quoted_charges</code>
        resource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.</p></div>
      properties:
        charges:
          type: array
          deprecated: false
          description: |
            Provides details of all the ad-hoc charges
            [added to the quote](/docs/api/v2/pcv-1/quotes/create-quote-for-one-time-charges)
            .
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 1
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the amount for the one-time charge. The value is in [major units of the currency](/docs/api/getting-started).
                  Applicable only when multi-decimal pricing is enabled.
                maxLength: 39
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  Description for this charge
                maxLength: 250
                example: null
              service_period_in_days:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Specifies the service period of the charge in days. When the quote is converted, the <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_from</a></code>
                  is set to current date/time and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.line_item.date_to</code>
                  is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">service_period_in_days</code>
                  ahead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date_from</code>
                  .</p>
                maximum: 4000
                minimum: 1
                example: null
              avalara_sale_type:
                type: string
                deprecated: false
                description: |
                  Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                  integration.
                  \* wholesale -

                  Transaction is a sale to another company that will resell your product or service to another consumer
                  \* consumed -

                  Transaction is for an item that is consumed directly
                  \* vendor_use -

                  Transaction is for an item that is subject to vendor use tax
                  \* retail -

                  Transaction is a sale to an end user
                enum:
                - wholesale
                - retail
                - consumed
                - vendor_use
                example: null
              avalara_transaction_type:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                  integration.
                example: null
              avalara_service_type:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)
                  integration.
                example: null
            example: null
          example: null
        addons:
          type: array
          deprecated: false
          description: |
            Provides details of the addons that are part of the quote.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon. Multiple addons can be passed.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                  </ul></div>
                minimum: 0
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                  </ul></div>
                maxLength: 39
                example: null
              proration_type:
                type: string
                deprecated: false
                description: |
                  null
                enum:
                - full_term
                - partial_term
                - none
                example: null
              service_period:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Specifies the service period of the addon in days. When the quote is converted, the <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_from</a></code>
                  is set to current date/time and <code><a href="/docs/api/invoices/invoice-object#line_items">invoice.line_item.date_to</a></code>
                  is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">service_period</code>
                  days ahead of <code><a href="/docs/api/invoices/invoice-object#line_items">date_from</a></code>
                  .</p>
                example: null
            required:
            - id
            example: null
          example: null
        coupons:
          type: array
          deprecated: false
          description: |
            List of coupons for this charge
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                description: |
                  Used to uniquely identify the coupon
                maxLength: 100
                example: null
            required:
            - coupon_id
            example: null
          example: null
        coupon_applicability_mappings:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              applicable_item_price_ids:
                type: array
                deprecated: false
                items:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                example: null
            example: null
          example: null
      example: null
    QuotedDeltaRamp:
      type: object
      properties:
        line_items:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              item_level_discount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
            example: null
          example: null
      example: null
    QuotedRamp:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        line_items:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              item_type:
                type: string
                deprecated: false
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              billing_period:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              billing_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - week
                - month
                - year
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                maximum: 730
                minimum: 1
                example: null
              charge_on_event:
                type: string
                deprecated: false
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                deprecated: false
                example: null
              charge_on_option:
                type: string
                deprecated: false
                enum:
                - immediately
                - on_event
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              ramp_tier_id:
                type: string
                deprecated: false
                maxLength: 105
                example: null
              discount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              discount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              item_level_discount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              item_level_discount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              amount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              amount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              net_amount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              net_amount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                enum:
                - fixed_amount
                - percentage
                example: null
              percentage:
                type: number
                format: double
                deprecated: false
                maximum: 100
                minimum: 0.01
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                minimum: 0
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - item_level_coupon
                - document_level_coupon
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - week
                - month
                - year
                example: null
              included_in_mrr:
                type: boolean
                deprecated: false
                example: null
              apply_on:
                type: string
                deprecated: false
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
            required:
            - apply_on
            - created_at
            - duration_type
            - entity_type
            - id
            - included_in_mrr
            - type
            example: null
          example: null
        item_tiers:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              ramp_tier_id:
                type: string
                deprecated: false
                maxLength: 105
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - item_price_id
            - price
            - starting_unit
            example: null
          example: null
        coupon_applicability_mappings:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              applicable_item_price_ids:
                type: array
                deprecated: false
                items:
                  type: string
                  deprecated: false
                  maxLength: 100
                  example: null
                example: null
            example: null
          example: null
      required:
      - id
      example: null
    QuotedSubscription:
      type: object
      description: "<div class=\"api-description\"><span featureId=\"cb-quotes\"></span><p\
        \ class=\"mb-2\">When a <code><a href=\"/docs/api/quotes\">quote</a></code>\
        \ is created, it generates the <code class=\"bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >quoted_subscription</code> resource. This captures most of the details of\
        \ the subscription that would eventually be created once the quote is invoiced.\
        \ This resource is returned along with the quote for most of the associated\
        \ operations.</p></div>"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
          maxLength: 50
          example: null
        plan_id:
          type: string
          deprecated: false
          description: |
            Identifier of the plan for this subscription
          maxLength: 100
          example: null
        plan_quantity:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Represents the plan quantity for this subscription.
          minimum: 1
          example: null
        plan_unit_price:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        setup_fee:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        billing_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
          minimum: 1
          example: null
        billing_period_unit:
          type: string
          deprecated: false
          description: |
            Defines billing frequency in association with the billing period.
            \* week -

            Charge based on week(s)
            \* day -

            Charge based on day(s)
            \* month -

            Charge based on month(s)
            \* year -

            Charge based on year(s)
          enum:
          - day
          - week
          - month
          - year
          example: null
        start_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code>
            of the quote is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_subscription_for_customer</code>.
            For subscriptions in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
            , this is the date/time when the subscription is set to start. The quote can be converted on a date/time after this date. This is called backdating the subscription creation. Backdating is performed when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">Backdating is enabled for subscription creation operations.</li>
            <li class="text-base leading-relaxed">The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.</li>
            <li class="text-base leading-relaxed">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription&#x27;s plan is 2 months and today is 14th April, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code> cannot be earlier than 14th February.</li>
            </ul>
          example: null
        trial_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.
          example: null
        remaining_billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |
            * When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
            * When the subscription is on a [contract term](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
          minimum: 0
          example: null
        po_number:
          type: string
          deprecated: false
          description: |
            Purchase order number for this subscription.
          maxLength: 100
          example: null
        auto_collection:
          type: string
          deprecated: false
          description: |
            Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
            \* on -

            Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
            \* off -

            Automatic collection of charges will not be made for this subscription. Use this for offline payments.
          enum:
          - "on"
          - "off"
          example: null
        plan_quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 33
          example: null
        plan_unit_price_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 39
          example: null
        changes_scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code>
            of the quote is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_subscription</code>.
            When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_option</code>
            is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">specific_date</code>
            , then this is the date/time at which the subscription change is scheduled to occur. The quote can be converted on a date/time after this date. This is called backdating the subscription change and performed when the subscription change has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">
            <p class="mb-2">Backdating must be enabled for subscription change operations.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Only the following changes can be backdated:</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Changes in the recurring items or their prices.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Addition of non-recurring items.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non_renewing</code>.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">The date is on or after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_start</code>.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">The date is on or after the last date/time any of the following changes were made:</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Changes in the recurring items or their prices.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">Addition of non-recurring items.</p>
            </li>
            <li class="text-base leading-relaxed">
            <p class="mb-2">The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription&#x27;s plan is 2 months and today is 14th April, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code> cannot be earlier than 14th February.</p>
            </li>
            </ul>
          example: null
        change_option:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">operation_type</code>
            of the quote is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">change_subscription</code>.
            When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.</p>
            * end_of_term - <p class="mb-2">The change is scheduled to be carried out at the end of the billing cycle of the subscription.</p>
            * specific_date - <p class="mb-2">The change is carried out as of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">changes_scheduled_at</code>
            .</p>
            * immediately - <p class="mb-2">The change is carried out immediately upon quote conversion.</p>
          enum:
          - end_of_term
          - specific_date
          - immediately
          example: null
        free_period:
          type: integer
          format: int32
          deprecated: false
          minimum: 1
          example: null
        free_period_unit:
          type: string
          deprecated: false
          description: |
            null
          enum:
          - day
          - week
          - month
          - year
          example: null
        contract_term_billing_cycle_on_renewal:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
            or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
            .</p>
          maximum: 100
          minimum: 1
          example: null
        addons:
          type: array
          deprecated: false
          description: |
            List of addons for this subscription with quantity(if applicable)
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon. Multiple addons can be passed.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/getting-started">type of currency</a>.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                  </ul></div>
                minimum: 0
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the addon. The format of the value [depends upon the currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              trial_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |-
                  <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                  status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                  )</p>
                example: null
              remaining_billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of billing cycles this addon will be attached to subscription.
                minimum: 0
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                  </ul></div>
                maxLength: 39
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the addon, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 39
                example: null
              proration_type:
                type: string
                deprecated: false
                description: |
                  null
                enum:
                - full_term
                - partial_term
                - none
                example: null
            required:
            - id
            example: null
          example: null
        event_based_addons:
          type: array
          deprecated: false
          description: |
            List of non-recurring addons that will be charged on the occurrence of specified event.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique 'id' used to identify the addon.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 0
                example: null
              on_event:
                type: string
                deprecated: false
                description: |
                  Event on which this addon will be charged.
                  \* plan_activation -

                  Addon will be charged on plan activation.
                  \* subscription_activation -

                  Addon will be charged on subscription activation.
                  \* subscription_creation -

                  Addon will be charged on subscription creation.
                  \* subscription_trial_start -

                  Addon will be charged when the trial period starts.
                  \* contract_termination -

                  Addon will be charged on contract termination.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                default: true
                deprecated: false
                description: |
                  If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 39
                example: null
            required:
            - charge_once
            - id
            - on_event
            - quantity
            - unit_price
            example: null
          example: null
        coupons:
          type: array
          deprecated: false
          description: |
            List of coupons for this subscription
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                description: |
                  Used to uniquely identify the coupon
                maxLength: 100
                example: null
            required:
            - coupon_id
            example: null
          example: null
        quoted_contract_term:
          type: object
          deprecated: false
          description: |
            The details of the contract term to be created when this quote is invoiced.
          properties:
            contract_start:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The start date of the contract term
              example: null
            contract_end:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The end date of the contract term
              example: null
            billing_cycle:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of billing cycles of the subscription that the contract term is for.
              minimum: 0
              example: null
            action_at_term_end:
              type: string
              default: renew
              deprecated: false
              description: |-
                <p class="mb-2">Action to be taken when the contract term completes.</p>
                * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                </ul>
                * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                </ul>
                * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
            total_contract_value:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |-
                <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
                of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                contract terms, this is a predicted value. The value depends on the <a href="/docs/api/v2/pcv-1/quoted_subscriptions">type of currency</a>.
                If the subscription was <a href="/docs/api/v2/pcv-1/quoted_subscriptions">imported</a>
                with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
                .</p>
              minimum: 0
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
              example: null
          required:
          - action_at_term_end
          - billing_cycle
          - contract_end
          - contract_start
          - total_contract_value
          example: null
      required:
      - id
      - plan_id
      - plan_quantity
      example: null
    ReasonCode:
      type: object
      properties:
        type:
          type: string
          deprecated: false
          enum:
          - subscription_cancellation
          - create_credit_note
          - refund_credit_note
          - void_invoice
          - order_resend
          example: null
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        code:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - enabled
          - disabled
          example: null
      required:
      - code
      - id
      - status
      - type
      example: null
    ReferenceCount:
      type: object
      description: |
        This resource returns the number of items.
      properties:
        type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item</code></p>
            * charge - <p class="mb-2">Charge</p>
            * plan - <p class="mb-2">Plan</p>
            * addon - <p class="mb-2">Addon</p>
          enum:
          - plan
          - addon
          - charge
          - plan_price
          - addon_price
          example: null
        count:
          type: integer
          format: int64
          deprecated: false
          description: |
            Number of items.
          example: null
      example: null
    ReferralSystem:
      type: string
      deprecated: false
      enum:
      - referral_candy
      - referral_saasquatch
      - friendbuy
      example: null
    ReferrerRewardType:
      type: string
      deprecated: false
      enum:
      - none
      - referral_direct_reward
      - custom_promotional_credit
      - custom_revenue_percent_based
      example: null
    RefundInitiatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_note:
              $ref: "#/components/schemas/CreditNote"
            customer:
              $ref: "#/components/schemas/Customer"
            subscription:
              $ref: "#/components/schemas/Subscription"
            card:
              $ref: "#/components/schemas/Card"
          required:
          - card
          - credit_note
          - customer
          - invoice
          - subscription
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    RefundableCreditsHandling:
      type: string
      deprecated: false
      enum:
      - no_action
      - schedule_refund
      example: null
    ReportBy:
      type: string
      deprecated: false
      enum:
      - customer
      - invoice
      - product
      - subscription
      example: null
    ResourceMigration:
      type: object
      description: |
        Resource Migration is used for finding the status of customer migration between Chargebee sites.
      properties:
        from_site:
          type: string
          deprecated: false
          description: |
            Domain name to which the item is moved.
          maxLength: 50
          minLength: 4
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Type of the entity this record is stored for
            \* customer -

            Entity that represents a customer
          enum:
          - customer
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            Handle of the customer in the current site.
          maxLength: 100
          example: null
        status:
          type: string
          default: failed
          deprecated: false
          description: |
            Status of the copy customer process.
            \* failed -

            Failed
            \* succeeded -

            Succeeded
            \* scheduled -

            Scheduled
          enum:
          - scheduled
          - failed
          - succeeded
          example: null
        errors:
          type: string
          deprecated: false
          description: |
            Filled only if the copy operation gets failed
          maxLength: 65000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time the log is created
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time the log is updated
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - from_site
      - status
      - updated_at
      example: null
    ResponseDocumentType:
      type: string
      deprecated: false
      enum:
      - application_response
      example: null
    ResponseStatus:
      type: string
      deprecated: false
      enum:
      - accepted
      - rejected
      - message_acknowledgement
      - in_process
      - under_query
      - conditionally_accepted
      - paid
      example: null
    ResumeOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - specific_date
      example: null
    RetryEngine:
      type: string
      default: chargebee
      deprecated: false
      enum:
      - chargebee
      - flexpay
      - successplus
      example: null
    Role:
      type: string
      deprecated: false
      enum:
      - primary
      - backup
      - none
      example: null
    Rule:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        namespace:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        rule_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        rule_order:
          type: integer
          format: int32
          deprecated: false
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - active
          - disabled
          example: null
        conditions:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        outcome:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        deleted:
          type: boolean
          default: false
          deprecated: false
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - deleted
      - id
      - modified_at
      - namespace
      - rule_name
      - status
      example: null
    RuleCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            rule:
              $ref: "#/components/schemas/Rule"
          required:
          - rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    RuleDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            rule:
              $ref: "#/components/schemas/Rule"
          required:
          - rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    RuleUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            rule:
              $ref: "#/components/schemas/Rule"
          required:
          - rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ScheduleType:
      type: string
      deprecated: false
      enum:
      - immediate
      - specific_dates
      - fixed_intervals
      example: null
    SiteMigrationDetail:
      type: object
      description: |
        Site Migration details is used for finding the records that are moved in and moved out from one Chargebee site to another.
      properties:
        entity_id:
          type: string
          deprecated: false
          description: |
            Id of the entity in this site.
          maxLength: 100
          example: null
        other_site_name:
          type: string
          deprecated: false
          description: |
            Site name to which the record is moved in/out.
          maxLength: 50
          minLength: 4
          example: null
        entity_id_at_other_site:
          type: string
          deprecated: false
          description: |
            Entity Id of the record in the other site.
          maxLength: 100
          example: null
        migrated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Date in which the record is copied
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Entity Type of the record
            \* order -

            Entity that represents an order
            \* customer -

            Entity that represents a customer
            \* invoice -

            Invoice description
            \* subscription -

            Entity that represents a subscription of a customer
            \* transaction -

            Entity that represents a transaction.
            \* credit_note -

            Credit note description
          enum:
          - customer
          - subscription
          - invoice
          - credit_note
          - transaction
          - order
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the migration
            \* moving_out -

            Moving out from one cb site to another
            \* moved_in -

            Moved in from another cb site
            \* moved_out -

            Moved out from one cb site to another
          enum:
          - moved_in
          - moved_out
          - moving_out
          example: null
      required:
      - entity_id
      - entity_id_at_other_site
      - entity_type
      - migrated_at
      - other_site_name
      - status
      example: null
    SiteOwner:
      type: object
      description: |-
        <div class="api-description"><p class="mb-2">Represents a site owner in Chargebee.
        Each site owner includes a unique <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> and required <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>, and can optionally include <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">name</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_id</code>, and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>.</p></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the site owner. Maximum length is 40 characters. This field is required.
          maxLength: 40
          example: null
        email:
          type: string
          format: email
          deprecated: false
          description: |
            Email address of the site owner in valid email format. Maximum length is 70 characters. This field is required.
          maxLength: 70
          example: null
        name:
          type: string
          deprecated: false
          description: |
            Name of the site owner. Maximum length is 50 characters.
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            ID of the associated customer. Maximum length is 50 characters.
          maxLength: 50
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp when this site owner was last updated.
          example: null
      required:
      - email
      - id
      example: null
    SitePcMetaRecord:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        event:
          type: string
          deprecated: false
          enum:
          - site_upgrade
          - site_downgrade
          example: null
        pc_type:
          type: string
          deprecated: false
          enum:
          - pc1
          - pc2
          example: null
        occurred_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - event
      - id
      - occurred_at
      - pc_type
      example: null
    Source:
      type: string
      deprecated: false
      enum:
      - admin_console
      - api
      - bulk_operation
      - scheduled_job
      - hosted_page
      - portal
      - system
      - none
      - js_api
      - migration
      - external_service
      example: null
    Subscription:
      type: object
      additionalProperties: true
      description: |-
        <div class="api-description"><p class="mb-2">Subscription represents the recurring items a customer has subscribed to. The recurring items can be - plan, addons. It may also contain the discount items like coupons.</p><p class="mb-2">Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer&#x27;s credit card if &#x27;auto_collection&#x27; is turned &#x27;on&#x27;, otherwise the resulting invoice will be created as &#x27;Payment Due&#x27;.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        The maximum number of subscriptions for any given <a href="/docs/api/customers">customer</a>
        (<code><a href="/docs/api/subscriptions/subscription-object#status">active</a></code>
        or not) is 900.</p></div><div id="tax-provider" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#tax-provider-content" aria-expanded="false" aria-controls="tax-provider-content">Tax provider fields<i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="tax-provider-content"><p class="mb-2"><strong class="font-semibold">Avalara</strong>: Merchants using <strong class="font-semibold">Avalara Sales Tax</strong> can optionally associate each item price with a locationCode (from their Avalara company locations), so tax can be resolved correctly at the line item level.</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">locationCode</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Merchant to configure it on Avalara Platform under company locations</td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs having <a href="/docs/api/item_prices/item-price-object" class="text-blue-600 hover:text-blue-800 underline">Item Prices</a> attributes.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Anrok</strong>: Canadian customers can have multiple tax registration numbers. We currently support only sharing one tax registration number with Anrok. So we added a new field which can have comma separated multiple tax reg numbers for Anrok. Values configured in the field is passed as it is to Anrok for accurate tax calculation</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">additionalTaxRegistrationNumber</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Canadian tax registration numbers in comma separated fashion.</td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs involving customer attributes. Also includes APIs where we are creating new customers. Eg: estimate, subscription, hosted pages.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Vertex</strong>: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Vertex Platform for seamless integration</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        Field Id like <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customerCode</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customerClass</code>
        , and<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxExempted</code>
        belong to the customer object.</p><p class="mb-2">Field Id like <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productCode</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productClass</code>
        , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productTaxCode</code>
        , and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productClass</code>
        belong to the product object.</p></div><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field ID</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Value</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productCode</code></td><td colSpan="1" rowspan="4" style="vertical-align:top;text-align:center">Merchant to configure it on Vertex Platform</td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs having <a href="/docs/api/v2/pcv-1/plans/plan-object">Plan</a>(PC1), <a href="/docs/api/v2/pcv-1/addons/addon-object">Addons</a>(PC1) and <a href="/docs/api/item_prices/item-price-object">Item Prices</a>(PC2) attributes.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productClass</code></td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customerCode</code></td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customerClass</code></td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Taxamo:</strong> Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Taxamo Platform for seamless integration</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Id</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Value</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productTaxCode</code></td><td colSpan="1" rowspan="3" style="vertical-align:top;text-align:center">Merchant to configure it on Taxamo Platform</td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs having <a href="/docs/api/v2/pcv-1/plans/plan-object">Plan</a>(PC1), <a href="/docs/api/v2/pcv-1/addons/addon-object">Addons</a>(PC1) and Item Prices (PC2) attributes.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">productClass</code></td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">taxExempted</code></td><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">cbtaxes</strong>: With CBTaxes, you can activate India IGST for customers located in Special Economic Zones (SEZ), implement zero-rated tax for SEZ customers, enable India IGST for customers outside of India, and set up zero-rated tax for customers outside of India.</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="2" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">indiaSez</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SEZ_IGST_TAX</code></td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SEZ_ZERO_RATED_TAX</code></td></tr><tr><td colSpan="1" rowspan="2" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">indiaExport</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">EXPORT_IGST_TAX</code></td></tr><tr><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">EXPORT_ZERO_RATED_TAX</code></td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">All</strong>: For tax inclusive tax calculation, For tax exclusive tax calculation. This is currently used for price type overriding at customer level</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th style="text-align:center;vertical-align:top">Field ID</th><th style="text-align:center;vertical-align:top">Field Value</th><th style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">priceType</code></td><td style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TAX_INCLUSIVE</code></td><td style="text-align:center;vertical-align:top">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td style="text-align:center;vertical-align:top"></td><td style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TAX_EXCLUSIVE</code></td><td style="text-align:center;vertical-align:top"></td></tr><tr><td style="text-align:center;vertical-align:top"></td><td style="text-align:center;vertical-align:top"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">SITE_DEFAULT</code></td><td style="text-align:center;vertical-align:top">Removes price type override, and allows site level configuration to be used for tax calculation.</td></tr></tbody></table></div></div></div><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong>
        Make sure you choose the correct <strong class="font-semibold">Field ID</strong>
        and <strong class="font-semibold">Available APIs</strong>
        combination from the table above.
        All Product Catalog APIs include <a href="/docs/api/v2/pcv-1/plans">Plans</a>
        , <a href="/docs/api/v2/pcv-1/addons">Addons</a>
        , <a href="/docs/api/v2/pcv-1/coupons">Coupons</a>
        , <a href="/docs/api/v2/pcv-1/coupon_sets">Coupon Sets</a>
        , <a href="/docs/api/v2/pcv-1/coupon_codes">Coupon Codes</a>
        .</p></div></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
          maxLength: 50
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
            ) of the subscription
          maxLength: 3
          example: null
        plan_id:
          type: string
          deprecated: false
          description: |
            Identifier of the plan for this subscription
          maxLength: 100
          example: null
        plan_quantity:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Represents the plan quantity for this subscription.
          minimum: 1
          example: null
        plan_unit_price:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        setup_fee:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        billing_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
          minimum: 1
          example: null
        billing_period_unit:
          type: string
          deprecated: false
          description: |
            Defines billing frequency in association with the billing period.
            \* day -

            Charge based on day(s)
            \* month -

            Charge based on month(s)
            \* year -

            Charge based on year(s)
            \* week -

            Charge based on week(s)
          enum:
          - day
          - week
          - month
          - year
          example: null
        start_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Applicable only for 'future' subscriptions. The scheduled start time of the subscription.
          example: null
        trial_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.
          example: null
        remaining_billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |
            * When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
            * When the subscription is on a [contract term](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
          minimum: 0
          example: null
        po_number:
          type: string
          deprecated: false
          description: |
            Purchase order number for this subscription.
          maxLength: 100
          example: null
        auto_collection:
          type: string
          deprecated: false
          description: |
            Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
            \* on -

            Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
            \* off -

            Automatic collection of charges will not be made for this subscription. Use this for offline payments.
          enum:
          - "on"
          - "off"
          example: null
        plan_quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 33
          example: null
        plan_unit_price_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 39
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer with whom this subscription is associated.
          maxLength: 50
          example: null
        plan_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total amount for the plan.
          minimum: 0
          example: null
        plan_free_quantity:
          type: integer
          format: int32
          deprecated: false
          description: |
            The units of the item that will be free with this Plan.
          minimum: 0
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Current state of the subscription</p>
            * future - <p class="mb-2">The subscription is scheduled to start at a future date.</p>
            * non_renewing - <p class="mb-2">The subscription will be canceled at the end of the current term.</p>
            * active - <p class="mb-2">The subscription is active and will be charged for automatically based on the items in it.</p>
            * cancelled - <p class="mb-2">The subscription has been canceled and is no longer in service.</p>
            * transferred - <p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">transferred</code>
            status will be reflected on the source business entity&#x27;s subscription attribute once the <a href="https://www.chargebee.com/docs/2.0/mbe-getting-started-with-customer-transfer.html">customer transfer</a>
            activity is completed successfully. This status is only valid for <a href="https://www.chargebee.com/docs/2.0/product-catalog.html">product catalog 2.0</a>
            as the Multiple Business Entity features can only be enabled for product catalog 2.0.</p>
            * in_trial - <p class="mb-2">The subscription is in trial.</p>
            * paused - <p class="mb-2">The subscription is <a href="https://www.chargebee.com/docs/2.0/pause-subscription.html" target="_blank">paused</a>.
            The subscription will not renew while in this state.</p>
          enum:
          - future
          - in_trial
          - active
          - non_renewing
          - paused
          - cancelled
          - transferred
          example: null
        trial_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Start of the trial period for the subscription. Presence of this value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
            subscription implies the subscription will go into <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
            state when it starts.</p>
          example: null
        trial_end_action:
          type: string
          deprecated: false
          description: |
            Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
            \* activate_subscription -

            The subscription activates and charges are raised for non-metered items.
            \* cancel_subscription -

            The subscription cancels.
            \* plan_default -

            The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            at the time when the trial ends, takes effect.
            \* site_default -

            This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            at the time when the trial ends, takes effect.
          enum:
          - site_default
          - plan_default
          - activate_subscription
          - cancel_subscription
          example: null
        current_term_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start of the current billing period of the subscription.
          example: null
        current_term_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End of the current billing period of the subscription. Subscription is renewed immediately after this
          example: null
        next_billing_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">current_term_end</code>
            unless multiple subscription terms were invoiced in advance using the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">terms_to_charge</code>
            parameter.</p>
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the subscription was created.
          example: null
        started_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Time at which the subscription was started. Is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">null</code>
            for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code>
            subscriptions as it is yet to be started.</p>
          example: null
        activated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">Time at which the subscription <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
            last changed to
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>.
            For example, this value is updated when an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>
            or
            <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
            subscription activates.</p>
          example: null
        gift_id:
          type: string
          deprecated: false
          description: |
            References the gift if it is a gifted subscription.
          maxLength: 150
          example: null
        contract_term_billing_cycle_on_renewal:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
            or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a>
            .</p>
          maximum: 100
          minimum: 1
          example: null
        override_relationship:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , ignores the <a href="/docs/api/customers/customer-object#relationship">hierarchy relationship</a>
            and uses customer as payment and invoice owner.</p>
          example: null
        pause_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paused</code>
            state, it is the date/time when the subscription was paused.</p>
          example: null
        resume_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
          example: null
        cancelled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time at which subscription was cancelled or is set to be cancelled.
          example: null
        cancel_reason:
          type: string
          deprecated: false
          description: |
            The reason for canceling the subscription. Set by Chargebee automatically.
            \* no_card -

            No Card
            \* non_compliant_customer -

            Non Compliant Customer
            \* currency_incompatible_with_gateway -

            Currency incompatible with Gateway
            \* fraud_review_failed -

            Fraud Review Failed
            \* tax_calculation_failed -

            Tax Calculation Failed
            \* not_paid -

            Not Paid
            \* non_compliant_eu_customer -

            Non Compliant EU Customer
          enum:
          - not_paid
          - no_card
          - fraud_review_failed
          - non_compliant_eu_customer
          - tax_calculation_failed
          - currency_incompatible_with_gateway
          - non_compliant_customer
          example: null
        affiliate_token:
          type: string
          deprecated: false
          description: |
            A unique tracking token
          maxLength: 250
          example: null
        created_from_ip:
          type: string
          deprecated: false
          description: |
            The IP address of the user. Used primarly in Refersion integration. Refersion uses this field to track/log affiliate subscription.
          maxLength: 50
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the item was last updated.
          example: null
        has_scheduled_advance_invoices:
          type: boolean
          default: false
          deprecated: false
          description: |
            The subscription has an [advance invoicing schedule](/docs/api/advance_invoice_schedules)
            .
          example: null
        has_scheduled_changes:
          type: boolean
          default: false
          deprecated: false
          description: |-
            <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , there are subscription changes scheduled on next renewal.</p>
          example: null
        payment_source_id:
          type: string
          deprecated: false
          description: |
            Payment source attached to this subscription. If present, customer's payment sources won't be used to collect any payment for this subscripiton.
          maxLength: 40
          example: null
        plan_free_quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The free_quantity_in_decimal as set for the plan. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 33
          example: null
        plan_amount_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the total amount for the plan, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 39
          example: null
        cancel_schedule_created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |-
            <p class="mb-2">This is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code>
            subscriptions or subscriptions that are scheduled for cancellation.</p>
          example: null
        offline_payment_method:
          type: string
          deprecated: false
          description: |
            The preferred offline payment method for the subscription.
            \* sepa_credit -

            SEPA Credit
            \* cash -

            Cash
            \* no_preference -

            No Preference
            \* bank_transfer -

            Bank Transfer
            \* check -

            Check
            \* eu_automated_bank_transfer -

            EU Automated Bank Transfer
            \* jp_automated_bank_transfer -

            JP Automated Bank Transfer
            \* uk_automated_bank_transfer -

            UK Automated Bank Transfer
            \* custom -

            Custom
            \* boleto -

            Boleto
            \* mx_automated_bank_transfer -

            MX Automated Bank Transfer
            \* us_automated_bank_transfer -

            US Automated Bank Transfer
            \* ach_credit -

            ACH Credit
          enum:
          - no_preference
          - cash
          - check
          - bank_transfer
          - ach_credit
          - sepa_credit
          - boleto
          - us_automated_bank_transfer
          - eu_automated_bank_transfer
          - uk_automated_bank_transfer
          - jp_automated_bank_transfer
          - mx_automated_bank_transfer
          - custom
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\\* play_store -\n\nThe object data is synchronized\
            \ with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Google Play Store. Direct manipulation of this object via UI\
            \ or API is disallowed.  \nIn-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\nfor more\
            \ information.\n\\* web -\n\nThe object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n\\* app_store\
            \ -\n\nThe object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)\n\
            created in Apple App Store. Direct manipulation of this object via UI\
            \ or API is disallowed.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        active_id:
          type: string
          deprecated: false
          description: |
            This attribute is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)
            as the Multiple Business Entity features can only be enabled for product catalog 2.0.
          maxLength: 50
          example: null
        due_invoices_count:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">Total number of invoices that are due for payment against the subscription.
            <strong class="font-semibold">Note:</strong>
            Not supported if <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">consolidated invoicing</a>
            is enabled, or when the subscription is for the customer who is in <a href="/docs/api/hierarchies">hierarchy</a>
            , and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">due_invoices_count</code>
            .</p>
          example: null
        due_since:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time since this subscription has unpaid invoices.
            **Note:**
            Not supported if [consolidated invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)
            is enabled, or when the subscription is for the customer who is in [hierarchy](/docs/api/hierarchies)
            , and the parent of this customer owns and pays for the invoices of the subscription.
          example: null
        total_dues:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Total invoice due amount for this subscription. The value depends on the <a href="/docs/api/v2/pcv-1/subscriptions">type of currency</a>
            .
            <strong class="font-semibold">Note:</strong>
            Not supported if <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">consolidated invoicing</a>
            is enabled, or when the subscription is for the customer who is in <a href="/docs/api/hierarchies">hierarchy</a>
            , and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_dues</code>
            .</p>
          minimum: 0
          example: null
        mrr:
          type: integer
          format: int64
          deprecated: false
          description: |
            Monthly recurring revenue for the subscription. Updated asynchronously, this value catches up with changes to the subscription in less than a minute. The value depends on the [type of currency](/docs/api/currencies)
            .
            **Note:**
            This may not return accurate values since updated asynchronously.
          minimum: 1
          example: null
        exchange_rate:
          type: number
          format: decimal
          deprecated: false
          description: |
            Exchange rate used for base currency conversion.This value is updated to the [rate configured](https://www.chargebee.com/docs/multi-currency-pricing.html#configuring-multicurrency)
            on your site each time any change is made to the subscription.
          maximum: 1000000000
          minimum: 0.0000000010
          example: null
        base_currency_code:
          type: string
          deprecated: false
          description: |
            The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
            ) of the site's base currency.
          maxLength: 3
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)
            displayed on the invoice PDF.
          maxLength: 2000
          example: null
        meta_data:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the subscription. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/v2/pcv-1/advanced-features) .
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Indicates that the subscription has been deleted when the value is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
            You can retrieve a deleted subscription using the <a href="/docs/api/subscriptions/list-subscriptions">list operation</a>
            .</p>
          example: null
        changes_scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            If a subscription change has been scheduled, this is the date/time when the change is set to take effect. **Note:**
            As a limitation, this attribute is not returned when the change is scheduled to happen at the end of the current term.
          example: null
        cancel_reason_code:
          type: string
          deprecated: false
          description: |
            Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**.
            Must be passed if set as mandatory in the app. The codes are case-sensitive
          maxLength: 100
          example: null
        free_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit."
          example: null
        free_period_unit:
          type: string
          deprecated: false
          description: |
            Defines additional free period in association with the billing period.
            \* week -

            Charge based on week(s)
            \* month -

            Charge based on month(s)
            \* day -

            Charge based on day(s)
            \* year -

            Charge based on year(s)
          enum:
          - day
          - week
          - month
          - year
          example: null
        create_pending_invoices:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Indicates whether the invoices for this subscription are generated with a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>. This attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> automatically when the subscription has item prices that belong to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items.
            You can also set this to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> explicitly using the <a href="/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices">create</a>/<a href="/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices">update</a> subscription operations. This is useful in the following scenarios:</p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a <a href="https://www.chargebee.com/docs/charges.html" target="_blank">one-time charge</a> at the end of the billing term.</li>
            <li class="text-base leading-relaxed">When you need to inspect all charges before closing invoices for this subscription.
            Applicable only when <a href="https://www.chargebee.com/docs/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site</li>
            </ul>
          example: null
        auto_close_invoices:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">Set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            to override for this subscription, the <a href="https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a>
            for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>
            .</p>
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        decommissioned:
          type: boolean
          default: false
          deprecated: false
          example: null
        addons:
          type: array
          deprecated: false
          description: |
            List of addons for this subscription with quantity(if applicable)
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Identifier of the addon. Multiple addons can be passed.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price or per-unit-price of the addon. The value depends on the <a href="/docs/api/v2/pcv-1/currencies/handling-currency-units">type of currency</a>.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the <a href="/docs/api/v2/pcv-1/addons/addon-object#period">addon period</a>. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price</code> provided is $10</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10 on each subscription renewal.</li>
                  </ul></div>
                minimum: 0
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the addon. The format of the value [depends upon the currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              trial_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |-
                  <p class="mb-2">The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">non-renewing</code>
                  status. Once set, the value can&#x27;t be changed. (Addon trial periods must be enabled by <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a>
                  )</p>
                example: null
              remaining_billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of billing cycles this addon will be attached to subscription.
                minimum: 0
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><p class="mb-2">For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
                  <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_price_in_decimal</code> provided is $10.75</li>
                  <li class="text-base leading-relaxed">The addon billing period is 1 month.</li>
                  <li class="text-base leading-relaxed">The plan billing period is 3 months.</li>
                  <li class="text-base leading-relaxed">The addon is only billed for $10.75 on each subscription renewal.</li>
                  </ul></div>
                maxLength: 39
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the addon, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 39
                example: null
              proration_type:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Specifies how to manage charges or credits for the addon during a subscription update.</p>
                  <p class="mb-2">You can&#x27;t modify this parameter&#x27;s value within the current term. Moreover, it is removed from the subscription attributes when the next term starts.</p>
                  <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">See also:</strong>
                  <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addons[proration_type]</code>
                  parameter for <a href="/docs/api/v2/pcv-1/subscriptions/update-a-subscription">Update a subscription API</a>
                  .</p></div>
                  <span featureId="cb-addon-proration" isMicro="true"></span>
                  * partial_term - <p class="mb-2">Prorate the charges or credits from the time of the change till the end of the current term.</p>
                  * none - <p class="mb-2">Don&#x27;t apply any charges or credits for the addon.</p>
                  * full_term - <p class="mb-2">Charge the full price of the addon or give the full credit. Don&#x27;t apply any proration.</p>
                enum:
                - full_term
                - partial_term
                - none
                example: null
            required:
            - id
            example: null
          example: null
        event_based_addons:
          type: array
          deprecated: false
          description: |
            List of non-recurring addons that will be charged on the occurrence of specified event.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique 'id' used to identify the addon.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |-
                  <p class="mb-2">Quantity of the addon. Applicable for addons with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  other than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>
                  .</p>
                minimum: 1
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 0
                example: null
              on_event:
                type: string
                deprecated: false
                description: |
                  Event on which this addon will be charged.
                  \* subscription_creation -

                  Addon will be charged on subscription creation.
                  \* subscription_trial_start -

                  Addon will be charged when the trial period starts.
                  \* plan_activation -

                  Addon will be charged on plan activation.
                  \* contract_termination -

                  Addon will be charged on contract termination.
                  \* subscription_activation -

                  Addon will be charged on subscription activation.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                default: true
                deprecated: false
                description: |
                  If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
                  is enabled.
                maxLength: 39
                example: null
            required:
            - charge_once
            - id
            - on_event
            - quantity
            - unit_price
            example: null
          example: null
        charged_event_based_addons:
          type: array
          deprecated: false
          description: |
            List of event_based_addons that have already been charged.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Addon id.
                maxLength: 100
                example: null
              last_charged_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this add-on was last charged for this subscription.
                example: null
            required:
            - id
            - last_charged_at
            example: null
          example: null
        coupons:
          type: array
          deprecated: false
          description: |
            List of coupons for this subscription
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                description: |
                  Used to uniquely identify the coupon
                maxLength: 100
                example: null
              apply_till:
                type: integer
                format: unix-time
                deprecated: false
                description: |-
                  <p class="mb-2">The date till when the coupon can be applied. Applicable for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">limited_period</code>
                  <a href="/docs/api/coupons">coupons</a>
                  only.</p>
                example: null
              applied_count:
                type: integer
                format: int32
                default: 0
                deprecated: false
                description: |
                  Number of times this coupon has been applied for this subscription
                example: null
              coupon_code:
                type: string
                deprecated: false
                description: |
                  The coupon code used to redeem the coupon. Will be present only when associated code for a coupon is used.
                maxLength: 50
                example: null
            required:
            - applied_count
            - coupon_id
            example: null
          example: null
        shipping_address:
          type: object
          deprecated: false
          description: |
            Shipping address for the subscription.
          properties:
            first_name:
              type: string
              deprecated: false
              description: |
                The first name of the contact.
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              description: |
                The last name of the contact.
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              description: |
                The email address.
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              description: |
                The company name.
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              description: |
                The phone number.
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              description: |
                Address line 1
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              description: |
                Address line 2
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              description: |
                Address line 3
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              description: |
                The name of the city.
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a>
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>
                as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>
                ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>
                ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code>
                (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code>
                ).</p>
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: |-
                <p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a>
                .</p>
                <p class="mb-2"><strong class="font-semibold">Note</strong>:
                If you enter an invalid country code, the system will return an error.</p>
                <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              description: |
                Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address)
                .
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              description: |
                The address verification status.
                \* not_validated -

                Address is not yet validated.
                \* valid -

                Address was validated successfully.
                \* partially_valid -

                The address is valid for taxability but has not been validated for shipping.
                \* invalid -

                Address is invalid.
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        referral_info:
          type: object
          deprecated: false
          description: |
            Referral details if exists for the subscription
          properties:
            referral_code:
              type: string
              deprecated: false
              description: |
                Referral code if available for the subscription
              maxLength: 50
              example: null
            coupon_code:
              type: string
              deprecated: false
              description: |
                Referral coupon code if available for the subscription
              maxLength: 50
              example: null
            referrer_id:
              type: string
              deprecated: false
              description: |
                Referrer id if available for the subscription
              maxLength: 19
              example: null
            external_reference_id:
              type: string
              deprecated: false
              description: |
                External reference id in referral system for the subscription
              maxLength: 50
              example: null
            reward_status:
              type: string
              default: pending
              deprecated: false
              description: |
                Reward status for the referral subscription
                \* paid -

                Paid
                \* invalid -

                Invalid
                \* pending -

                Pending
              enum:
              - pending
              - paid
              - invalid
              example: null
            referral_system:
              type: string
              deprecated: false
              description: |
                Source referral system for the referral subscription
                \* referral_saasquatch -

                Referral Saasquatch
                \* referral_candy -

                Referral Candy
                \* friendbuy -

                Friendbuy
              enum:
              - referral_candy
              - referral_saasquatch
              - friendbuy
              example: null
            account_id:
              type: string
              deprecated: false
              description: |
                Referral account id
              maxLength: 50
              example: null
            campaign_id:
              type: string
              deprecated: false
              description: |
                Referral campaign id
              maxLength: 50
              example: null
            external_campaign_id:
              type: string
              deprecated: false
              description: |
                Referral external campaign id
              maxLength: 100
              example: null
            friend_offer_type:
              type: string
              deprecated: false
              description: |
                Friend offer type for the referral camapign
                \* none -

                None
                \* coupon_code -

                Coupon Code
                \* coupon -

                Coupon
              enum:
              - none
              - coupon
              - coupon_code
              example: null
            referrer_reward_type:
              type: string
              deprecated: false
              description: |
                Referrer reward type for the referral campaign
                \* none -

                None
                \* custom_revenue_percent_based -

                Custom Revenue Percent Based
                \* referral_direct_reward -

                Referral Direct Reward
                \* custom_promotional_credit -

                Custom Promotional Credit
              enum:
              - none
              - referral_direct_reward
              - custom_promotional_credit
              - custom_revenue_percent_based
              example: null
            notify_referral_system:
              type: string
              deprecated: false
              description: |
                Whether or not to notify the referral purchases to the referral system
                \* first_paid_conversion -

                First Paid Conversion
                \* none -

                None
                \* all_invoices -

                All Invoices
              enum:
              - none
              - first_paid_conversion
              - all_invoices
              example: null
            destination_url:
              type: string
              deprecated: false
              description: |
                Destination url for the referral campaign
              maxLength: 250
              example: null
            post_purchase_widget_enabled:
              type: boolean
              default: true
              deprecated: false
              description: |
                Whether post purchase widget is enabled for this campaign
              example: null
          required:
          - account_id
          - campaign_id
          - post_purchase_widget_enabled
          example: null
        contract_term:
          type: object
          deprecated: false
          description: |
            Contract terms for this subscription
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Id that uniquely identifies the contract term in the site.
              maxLength: 50
              example: null
            status:
              type: string
              deprecated: false
              description: |
                Current status of contract
                \* terminated -

                The contract term was terminated ahead of completion.
                \* completed -

                The contract term has run its full duration.
                \* active -

                An actively running contract term.
                \* cancelled -

                The contract term was ended because: - a change in the subscription caused a [subscription term reset](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#force_term_reset).

                * the subscription was cancelled due to non-payment.
              enum:
              - active
              - completed
              - cancelled
              - terminated
              example: null
            contract_start:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The start date of the contract term
              example: null
            contract_end:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The end date of the contract term
              example: null
            billing_cycle:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of billing cycles of the subscription that the contract term is for.
              minimum: 0
              example: null
            action_at_term_end:
              type: string
              default: renew
              deprecated: false
              description: |-
                <p class="mb-2">Action to be taken when the contract term completes.</p>
                * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: -   Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p>
                <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancel</code>.</li>
                </ul>
                * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>
                * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p>
                * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2">
                <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</li>
                <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">action_at_term_end</code> for the new contract term is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">renew</code>.</li>
                </ul>
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
            total_contract_value:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |-
                <p class="mb-2">The sum of the <a href="/docs/api/invoices/invoice-object#total">totals</a>
                of all the invoices raised as part of the contract term. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                contract terms, this is a predicted value. The value depends on the <a href="/docs/api/currencies">type of currency</a>.
                If the subscription was <a href="/docs/api/v2/pcv-1/subscriptions/import-a-subscription">imported</a>
                with the contract term, then this value includes the value passed for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised</code>
                .</p>
              minimum: 0
              example: null
            total_contract_value_before_tax:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |-
                <p class="mb-2">It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">total_amount_raised_before_tax</code>
                is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.</p>
              minimum: 0
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a>
                , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The date when the contract term was created.
              example: null
            subscription_id:
              type: string
              deprecated: false
              description: |
                The [Id](/docs/api/subscriptions/subscription-object#id)
                of the subscription that this contract term is for.
              maxLength: 50
              example: null
            remaining_billing_cycles:
              type: integer
              format: int32
              deprecated: false
              description: |-
                <p class="mb-2">The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code>
                contract terms.</p>
              minimum: 0
              example: null
          required:
          - action_at_term_end
          - billing_cycle
          - contract_end
          - contract_start
          - created_at
          - id
          - status
          - subscription_id
          - total_contract_value
          - total_contract_value_before_tax
          example: null
      required:
      - currency_code
      - customer_id
      - decommissioned
      - deleted
      - has_scheduled_advance_invoices
      - has_scheduled_changes
      - id
      - plan_id
      - plan_quantity
      - status
      example: null
    SubscriptionActivatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - card
          - customer
          - invoice
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionActivatedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionAdvanceInvoiceScheduleAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            advance_invoice_schedules:
              type: array
              items:
                $ref: "#/components/schemas/AdvanceInvoiceSchedule"
              example: null
          required:
          - advance_invoice_schedules
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionAdvanceInvoiceScheduleRemovedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            advance_invoice_schedules:
              type: array
              items:
                $ref: "#/components/schemas/AdvanceInvoiceSchedule"
              example: null
          required:
          - advance_invoice_schedules
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionAdvanceInvoiceScheduleUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            advance_invoice_schedules:
              type: array
              items:
                $ref: "#/components/schemas/AdvanceInvoiceSchedule"
              example: null
          required:
          - advance_invoice_schedules
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCanceledWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCancellationReminderEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCancellationScheduledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCancelledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionChangedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionChangedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionChangesScheduledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionCreatedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionEstimate:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - future
          - in_trial
          - active
          - non_renewing
          - paused
          - cancelled
          - transferred
          example: null
        trial_end_action:
          type: string
          deprecated: false
          enum:
          - site_default
          - plan_default
          - activate_subscription
          - cancel_subscription
          example: null
        next_billing_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        pause_date:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        resume_date:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        shipping_address:
          type: object
          deprecated: false
          properties:
            first_name:
              type: string
              deprecated: false
              maxLength: 150
              example: null
            last_name:
              type: string
              deprecated: false
              maxLength: 150
              example: null
            email:
              type: string
              format: email
              deprecated: false
              maxLength: 70
              example: null
            company:
              type: string
              deprecated: false
              maxLength: 250
              example: null
            phone:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            line1:
              type: string
              deprecated: false
              maxLength: 150
              example: null
            line2:
              type: string
              deprecated: false
              maxLength: 150
              example: null
            line3:
              type: string
              deprecated: false
              maxLength: 150
              example: null
            city:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            state_code:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            zip:
              type: string
              deprecated: false
              maxLength: 20
              example: null
            validation_status:
              type: string
              default: not_validated
              deprecated: false
              enum:
              - not_validated
              - valid
              - partially_valid
              - invalid
              example: null
          example: null
        contract_term:
          type: object
          deprecated: false
          properties:
            id:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            status:
              type: string
              deprecated: false
              enum:
              - active
              - completed
              - cancelled
              - terminated
              example: null
            contract_start:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            contract_end:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            billing_cycle:
              type: integer
              format: int32
              deprecated: false
              minimum: 0
              example: null
            action_at_term_end:
              type: string
              default: renew
              deprecated: false
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
            total_contract_value:
              type: integer
              format: int64
              default: 0
              deprecated: false
              minimum: 0
              example: null
            total_contract_value_before_tax:
              type: integer
              format: int64
              default: 0
              deprecated: false
              minimum: 0
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            subscription_id:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            remaining_billing_cycles:
              type: integer
              format: int32
              deprecated: false
              minimum: 0
              example: null
          required:
          - action_at_term_end
          - billing_cycle
          - contract_end
          - contract_start
          - created_at
          - id
          - status
          - subscription_id
          - total_contract_value
          - total_contract_value_before_tax
          example: null
      required:
      - currency_code
      example: null
    SubscriptionHistory:
      type: object
      description: |
        This resource returns the subscription history.
      properties:
        item_price_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the item price.
          maxLength: 100
          example: null
        item_type:
          type: string
          deprecated: false
          description: |
            Type of items.
            \* addon -

            addon
            \* plan -

            plan
          enum:
          - plan
          - addon
          - charge
          example: null
        active_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp to indicate from when this item was attached to the subscription.
          example: null
        active_to:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp to indicate till when this item was attached to the subscription.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp to indicate when this subscription was created.
          example: null
        item_unit_amount_in_cents:
          type: integer
          format: int64
          deprecated: false
          example: null
        actual_item_unit_amount_in_cents:
          type: integer
          format: int64
          deprecated: false
          example: null
        item_amount_in_cents:
          type: integer
          format: int64
          deprecated: false
          example: null
        actual_item_amount_in_cents:
          type: integer
          format: int64
          deprecated: false
          example: null
        rating_group_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      example: null
    SubscriptionItemsRenewedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionMovedInEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
          required:
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionMovedOutEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
          required:
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionMovementFailedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
          required:
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionPauseScheduledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionPausedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_notes:
              type: array
              items:
                $ref: "#/components/schemas/CreditNote"
              example: null
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - credit_notes
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionPreview:
      type: object
      description: |
        This resource returns subscription preview attributes.
      properties:
        billing_event:
          type: string
          deprecated: false
          description: |
            Describes the time in the subscription lifecycle when the charge is to occur.
            \* subscription_changed -

            Subscription Changed
            \* subscription_resumed -

            Subscription Resumed
            \* subscription_renewed -

            Subscription Renewed
            \* subscription_activated -

            Subscription Activated
            \* subscription_cancelled -

            Subscription Cancelled
            \* subscription_started -

            Subscription Started
            \* subscription_paused -

            Subscription Paused
            \* subscription_created -

            Subscription Created
          enum:
          - subscription_created
          - subscription_changed
          - subscription_renewed
          - subscription_cancelled
          - subscription_resumed
          - subscription_paused
          - subscription_started
          - subscription_activated
          example: null
        billing_sequence_number:
          type: integer
          format: int32
          deprecated: false
          description: |
            Billing sequence number.
          example: null
        occurred_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicate when the event was occurred.
          example: null
        subscription:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            JSON object representing subscription
          example: null
        invoices:
          type: array
          deprecated: false
          description: |
            JSON object representing invoice
          items:
            example: null
          example: null
        credit_notes:
          type: array
          deprecated: false
          description: |
            JSON object representing credit notes
          items:
            example: null
          example: null
        unbilled_charges:
          type: array
          deprecated: false
          description: |
            Represents the preview of the unbilled charges generated during 'estimate' operation.
          items:
            example: null
          example: null
      required:
      - subscription
      example: null
    SubscriptionReactivatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionReactivatedWithBackdatingEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRenewalReminderEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRenewedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionResumedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - card
          - customer
          - invoice
          - subscription
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionResumptionScheduledEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionScheduledCancellationRemovedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionScheduledChange:
      type: object
      properties:
        action_type:
          type: string
          deprecated: false
          enum:
          - cancel
          - pause
          - reactivate
          example: null
        data:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - action_type
      - created_at
      - modified_at
      example: null
    SubscriptionScheduledChangesRemovedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionScheduledPauseRemovedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionScheduledResumptionRemovedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionShippingAddressUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionStartedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - card
          - customer
          - invoice
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionTrialEndReminderEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionTrialExtendedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            subscription:
              $ref: "#/components/schemas/Subscription"
            customer:
              $ref: "#/components/schemas/Customer"
            card:
              $ref: "#/components/schemas/Card"
            advance_invoice_schedule:
              $ref: "#/components/schemas/AdvanceInvoiceSchedule"
          required:
          - advance_invoice_schedule
          - card
          - customer
          - subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TaxExemptReason:
      type: string
      deprecated: false
      enum:
      - tax_not_configured
      - region_non_taxable
      - export
      - customer_exempt
      - product_exempt
      - zero_rated
      - reverse_charge
      - high_value_physical_goods
      - zero_value_item
      - tax_not_configured_external_provider
      example: null
    TaxJurisType:
      type: string
      deprecated: false
      enum:
      - country
      - federal
      - state
      - county
      - city
      - special
      - unincorporated
      - other
      example: null
    TaxOverrideReason:
      type: string
      deprecated: false
      enum:
      - id_exempt
      - customer_exempt
      - export
      example: null
    TaxWithheld:
      type: object
      description: |-
        <div class="api-description"><span featureId="cb-tax-withheld"></span><p class="mb-2">Tax regulations in many countries allow taxes to be deducted by the buyer while making payments for products and services. The buyer then pays this tax to the taxation authority. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_withheld</code> resource captures the details of such tax deductions.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2">
        <li class="text-base leading-relaxed">This resource is available as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_taxes_withheld</code> sub-resource under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice</code>s.</li>
        <li class="text-base leading-relaxed">Whenever refunds are provided against this resource, they are available as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_tax_withheld_refunds</code> sub-resource under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credit_note</code>s.</li>
        </ul></div></div>
      properties:
        id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_</code>.
            For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tax_wh_16BdDXSlbu4uV1Ee6</code>
            .</p>
          maxLength: 40
          example: null
        reference_number:
          type: string
          deprecated: false
          description: |
            A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            The description for this tax withheld.
          maxLength: 65000
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Date or time associated with the tax withheld.
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api/getting-started)
            .
          minimum: 1
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - id
      example: null
    TaxWithheldDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            tax_withheld:
              $ref: "#/components/schemas/TaxWithheld"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          - invoice
          - tax_withheld
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TaxWithheldRecordedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            tax_withheld:
              $ref: "#/components/schemas/TaxWithheld"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          - invoice
          - tax_withheld
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TaxWithheldRefundedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            tax_withheld:
              $ref: "#/components/schemas/TaxWithheld"
            invoice:
              $ref: "#/components/schemas/Invoice"
            credit_note:
              $ref: "#/components/schemas/CreditNote"
          required:
          - credit_note
          - invoice
          - tax_withheld
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Taxability:
      type: string
      default: taxable
      deprecated: false
      enum:
      - taxable
      - exempt
      example: null
    TaxjarExemptionCategory:
      type: string
      deprecated: false
      enum:
      - wholesale
      - government
      - other
      example: null
    ThirdPartyPaymentMethod:
      type: object
      description: |
        Used when you want to copy card information between two gateways (such as copying cards between Authorize.Net and Stripe). Will contain details of the payment method type (card, Amazon Payments, etc.), name of the gateway, and the reference ID that the gateway uses to identify the specific card.
      properties:
        type:
          type: string
          default: card
          deprecated: false
          description: "Type of the payment method.\n\\* direct_debit -\n\nRepresents\
            \ bank account for which the direct debit or ACH agreement/mandate is\
            \ created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* google_pay\
            \ -\n\nPayments made via Google Pay.\n\\* sepa_instant_transfer -\n\n\
            Payments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made\
            \ via Dotpay.\n\\* pay_to -\n\nPayments made via PayTo\n\\* revolut_pay\
            \ -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made\
            \ via Naver Pay.\n\\* giropay -\n\nPayments made via giropay.\n\\* grab_pay\
            \ -\n\nPayments made via GrabPay\n\\* stablecoin -\n\nPayments made via\
            \ Stablecoin.\n\\* alipay -\n\nPayments made via Alipay.  \nThis payment\
            \ source is deprecated.\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\
            \\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments made\
            \ via Pix\n\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\
            \nPayments made via WeChat Pay.  \nThis payment source is deprecated.\n\
            \\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* bancontact\
            \ -\n\nPayments made via Bancontact Card.\n\\* go_pay -\n\nPayments made\
            \ via GoPay\n\\* card -\n\nCard based payment including credit cards and\
            \ debit cards. Details about the card can be obtained from the card resource.\n\
            \\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* pay_by_bank\
            \ -\n\nPay By Bank\n\\* online_banking_poland -\n\nPayments made via Online\
            \ Banking Poland\n\\* after_pay -\n\nPayments made via Afterpay\n\\* faster_payments\
            \ -\n\nPayments made via Faster Payments\n\\* generic -\n\nPayments made\
            \ via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\
            \\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* twint -\n\
            \nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\\
            * automated_bank_transfer -\n\nRepresents virtual bank account using which\
            \ the payment will be done.\n\\* paypal_express_checkout -\n\nPayments\
            \ made via PayPal Express Checkout.\n\\* venmo -\n\nPayments made via\
            \ Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\\* trustly -\n\nTrustly\n\
            \\* upi -\n\nUPI Payments.\n\\* kbc_payment_button -\n\nKBC Payment Button\n\
            \\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* payconiq_by_bancontact\
            \ -\n\nPayments made via Payconiq by Bancontact.\n\\* apple_pay -\n\n\
            Payments made via Apple Pay.\n\\* electronic_payment_standard -\n\nElectronic\
            \ Payment Standard\n"
          enum:
          - card
          - paypal_express_checkout
          - amazon_payments
          - direct_debit
          - generic
          - alipay
          - unionpay
          - apple_pay
          - wechat_pay
          - ideal
          - google_pay
          - sofort
          - bancontact
          - giropay
          - dotpay
          - upi
          - netbanking_emandates
          - venmo
          - pay_to
          - faster_payments
          - sepa_instant_transfer
          - automated_bank_transfer
          - klarna_pay_now
          - online_banking_poland
          - payconiq_by_bancontact
          - electronic_payment_standard
          - kbc_payment_button
          - pay_by_bank
          - trustly
          - stablecoin
          - kakao_pay
          - naver_pay
          - revolut_pay
          - cash_app_pay
          - twint
          - go_pay
          - grab_pay
          - pay_co
          - after_pay
          - swish
          - payme
          - pix
          - klarna
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Name of the gateway this card is stored with.\n\\* twikey\
            \ -\n\nTwikey is a payment service provider that specializes in processing\
            \ direct debit payments across the EU.\n\\* bluesnap -\n\nBlueSnap is\
            \ a payment gateway.\n\\* jp_morgan -\n\nJ.P. Morgan Mobility Payment\
            \ Solutions is a payment gateway that enables you to securely accept and\
            \ manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type).\
            \  \nThis feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature)\
            \ to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL\
            \ for your test and live sites.\n\\* tco -\n\n2Checkout is a payment gateway.\n\
            \\* deutsche_bank -\n\nDeutsche Bank is the leading German bank with strong\
            \ European roots and a global network.  \nThis feature is a **Private\
            \ Beta Release**.\n\\* bluepay -\n\nBluePay is a payment gateway.\n\\\
            * paypal_express_checkout -\n\nPayPal Express Checkout is a payment gateway.\n\
            \\* paypal_payflow_pro -\n\nPayPal Payflow Pro is a payment gateway.\n\
            \\* razorpay -\n\nRazorpay is a fast growing payment service provider\
            \ in India working with all leading banks and support for major local\
            \ payment methods including Netbanking, UPI etc.\n\\* global_payments\
            \ -\n\nGlobal Payments is a payment service provider.\n\\* dlocal -\n\n\
            Dlocal provides payment solutions for global commerce by accepting local\
            \ payment methods.\n\\* not_applicable -\n\nIndicates that payment gateway\
            \ is not applicable for this resource.\n\\* checkout_com -\n\nCheckout.com\
            \ is a payment gateway.\n\\* adyen -\n\nAdyen is a payment gateway.\n\\\
            * braintree -\n\nBraintree is a payment gateway.\n\\* nmi -\n\nNMI is\
            \ a payment gateway.\n\\* worldpay -\n\nWorldPay is a payment gateway\n\
            \\* paystack -\n\nPaystack is a payment gateway for businesses in Africa.\
            \ It enables secure payment acceptance both online and offline.  \nThis\
            \ feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
            \ to enable Paystack for your test and live sites.\n\\* pay_com -\n\n\
            Pay.com provides payment services focused on simplicity and hassle-free\
            \ operations for businesses of all sizes.\n\\* moneris_us -\n\nMoneris\
            \ USA is a payment gateway.\n\\* pin -\n\nPin is a payment gateway\n\\\
            * authorize_net -\n\nAuthorize.net is a payment gateway\n\\* stripe -\n\
            \nStripe is a payment gateway.\n\\* moneris -\n\nMoneris is a payment\
            \ gateway.\n\\* chargebee -\n\nChargebee test gateway.\n\\* cybersource\
            \ -\n\nCyberSource is a payment gateway.\n\\* ecentric -\n\nEcentric provides\
            \ a seamless payment processing service in South Africa specializing on\
            \ omnichannel capabilities.\n\\* first_data_global -\n\nFirst Data Global\
            \ Gateway Virtual Terminal Account\n\\* exact -\n\nExact Payments is a\
            \ payment gateway.\n\\* nuvei -\n\nNuvei is a secure and reliable payment\
            \ processing solution that allows you to accept payments from customers\
            \ and suitable for various types of businesses.  \nThis feature is a **Private\
            \ Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
            \ to enable Nuvei for your test and live sites.\n\\* eway -\n\neWAY Account\
            \ is a payment gateway.\n\\* metrics_global -\n\nMetrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            \\* amazon_payments -\n\nAmazon Payments is a payment service provider.\n\
            \\* windcave -\n\nWindcave provides an end to end payment processing solution\
            \ in ANZ and other leading global markets.\n\\* quickbooks -\n\nIntuit\
            \ QuickBooks Payments gateway\n\\* wepay -\n\nWePay is a payment gateway.\n\
            \\* ezidebit -\n\nEzidebit is a payment gateway integration based in Australia\
            \ that supports automated direct debit, BPAY, and card payments for businesses.\
            \  \nThis feature is a **Private Beta Release**.\n\\* wirecard -\n\nWireCard\
            \ Account is a payment service provider.\n\\* chargebee_payments -\n\n\
            Chargebee Payments gateway\n\\* sage_pay -\n\nSage Pay is a payment gateway.\n\
            \\* elavon -\n\nElavon Virtual Merchant is a payment solution.\n\\* paypal_pro\
            \ -\n\nPayPal Pro Account is a payment gateway.\n\\* orbital -\n\nChase\
            \ Paymentech(Orbital) is a payment gateway.\n\\* paypal -\n\nPayPal Commerce\
            \ is a payment gateway.\n\\* beanstream -\n\nBambora(formerly known as\
            \ Beanstream) is a payment gateway.\n\\* hdfc -\n\nHDFC Account is a payment\
            \ gateway.\n\\* ingenico_direct -\n\nWorldline Online Payments is a payment\
            \ gateway.\n\\* ogone -\n\nIngenico ePayments (formerly known as Ogone)\
            \ is a payment gateway.\n\\* migs -\n\nMasterCard Internet Gateway Service\
            \ payment gateway.\n\\* vantiv -\n\nVantiv is a payment gateway.\n\\*\
            \ bank_of_america -\n\nBank of America Gateway\n\\* eway_rapid -\n\neWAY\
            \ Rapid is a payment gateway.\n\\* gocardless -\n\nGoCardless is a payment\
            \ service provider.\n\\* mollie -\n\nMollie is a payment gateway.\n\\\
            * paymill -\n\nPAYMILL is a payment gateway.\n\\* balanced_payments -\n\
            \nBalanced is a payment gateway\n\\* solidgate -\n\nSolidgate is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \nThis\
            \ feature is a **Private Beta Release**.\n\\* ebanx -\n\nEBANX is a payment\
            \ gateway, enabling businesses to accept diverse local payment methods\
            \ from various countries for increased market reach and conversion.\n"
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account this payment method is stored with.
          maxLength: 50
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            Identifier provided by the gateway to reference that specific card.
          maxLength: 100
          example: null
      required:
      - gateway
      - reference_id
      - type
      example: null
    ThunkingPlan:
      type: object
      description: |
        This resource is used to return thunking plan.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The identifier for the item price. It is unique and immutable.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">A unique display name for the item price in the Chargebee UI. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">external_name</code>
            is not provided, this is also used in customer-facing pages and documents such as <a href="/docs/api/invoices">invoices</a>
            and <a href="/docs/api/hosted_pages">hosted pages</a>
            .</p>
          maxLength: 100
          example: null
        item_id:
          type: string
          deprecated: false
          description: |
            The id of the item that the item price belongs to.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the item price.
          maxLength: 2000
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The status of the item price.</p>
            * archived - <p class="mb-2">The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.</p>
            * active - <p class="mb-2">The item price can be used in subscriptions.</p>
            * deleted - <p class="mb-2">Indicates that the item price has been deleted. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">name</code>
            can be reused.</p>
          enum:
          - active
          - archived
          - deleted
          example: null
        external_name:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The name of the item price used in customer-facing pages and documents. These include <a href="/docs/api/invoices">invoices</a>
            and <a href="/docs/api/hosted_pages">hosted pages</a>.
            If not provided, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">name</code>
            is used</p>
          maxLength: 100
          example: null
        price_variant_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        proration_type:
          type: string
          deprecated: false
          description: |
            null
          enum:
          - site_default
          - partial_term
          - full_term
          example: null
        pricing_model:
          type: string
          default: flat_fee
          deprecated: false
          description: |-
            <p class="mb-2">The <a href="https://www.chargebee.com/docs/2.0/plans.html#pricing-models" target="_blank">pricing scheme</a> for this item price. If subscriptions, invoices or <a href="/docs/api/differential_prices">differential prices</a> exist for this item price, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code> cannot be changed.</p>
            * tiered - <p class="mb-2">There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.</p>
            * per_unit - <p class="mb-2">A fixed price per unit quantity.</p>
            * flat_fee - <p class="mb-2">A fixed price that is not quantity-based.</p>
            * volume - <p class="mb-2">The per unit price is based on the tier that the total quantity falls in.</p>
            * stairstep - <p class="mb-2">A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.</p>
          enum:
          - flat_fee
          - per_unit
          - tiered
          - volume
          - stairstep
          example: null
        price:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">The cost of the item price when the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
            When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the <a href="/docs/api/getting-started">minor unit of the currency</a>
            .</p>
          minimum: 0
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The price of the item when the pricing_model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">flat_fee</code>.
            When the pricing model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">per_unit</code>
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/getting-started" target="_blank">multi-decimal pricing</a>
            is enabled.</p>
          maxLength: 39
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed">When the item <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code>: The billing period of the plan in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>s. For example, create a 6 month plan by providing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code> as 6 and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code> as month.</li>
            <li class="text-base leading-relaxed">When item <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code>: The period of the addon in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>s. For example, create an addon with a 2 month <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code> by providing period as 2 and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">month</code>. The period of an addon is the duration for which its <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">price</code> applies. When attached to a plan, the addon is billed for the billing period of the plan. <a href="https://www.chargebee.com/docs/2.0/addons-billingcycle.html" target="_blank">Learn more.</a></li>
            </ul>
            <p class="mb-2">If subscriptions or invoices exist for this item price, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
            cannot be changed. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>
            is mandatory when the item <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code></p>
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The unit of time for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period</code>.
            If subscriptions or invoices exist for this item price, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
            cannot be changed. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code>
            is mandatory when the item <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code></p>
            * month - <p class="mb-2">A period of 1 calendar month.</p>
            * day - <p class="mb-2">A period of 24 hours.</p>
            * week - <p class="mb-2">A period of 7 days.</p>
            * year - <p class="mb-2">A period of 1 calendar year.</p>
          enum:
          - day
          - week
          - month
          - year
          example: null
        trial_period:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">The trial period of the plan in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_period_unit</code>
            s. You can also set <a href="https://www.chargebee.com/docs/2.0/addons-trial.html">trial periods for addons</a>
            ; contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Support</a>
            to enable that feature.</p>
          minimum: 0
          example: null
        trial_period_unit:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The unit of time for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">trial_period</code>
            .</p>
            * month - <p class="mb-2">A period of 1 calendar month.</p>
            * day - <p class="mb-2">A period of 24 hours.</p>
          enum:
          - day
          - month
          example: null
        trial_end_action:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Applicable only when <a href="https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">End-of-trial Action</a>
            has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item.type</code>
            is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code>
            and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the <a href="/docs/api/subscriptions/subscription-object#trial_end_action">subscription-level</a>
            .</p>
            * cancel_subscription - <p class="mb-2">The subscription cancels.</p>
            * activate_subscription - <p class="mb-2">The subscription activates and charges are raised for non-metered items.</p>
            * site_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a>
            at the time when the trial ends, takes effect.</p>
          enum:
          - site_default
          - activate_subscription
          - cancel_subscription
          example: null
        shipping_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
          minimum: 1
          example: null
        shipping_period_unit:
          type: string
          deprecated: false
          description: |
            Defines the shipping frequency in association with shipping period.
            \* year -

            A period of 1 calendar year.
            \* day -

            A period of 24 hours.
            \* week -

            A period of 7 days.
            \* month -

            A period of 1 calendar month.
          enum:
          - day
          - week
          - month
          - year
          example: null
        billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |-
            <p class="mb-2">The default number of billing cycles a subscription to the plan must run. Can be <a href="/docs/api/subscriptions">overridden</a> for a subscription.
            Addons can also <a href="https://www.chargebee.com/docs/2.0/addons-billingcycle.html" target="_blank">have billing cycles</a>. However, you must contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Support</a> to enable that. Also, for addons, you can <a href="/docs/api/attached_items">override this</a> while attaching it to a plan. However, if you provide the value while <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_type">applying the addon to a subscription</a>, then that value takes still higher precedence.
            If subscriptions, invoices or <a href="/docs/api/differential_prices">differential prices</a>
            exist for this item price, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_cycles</code>
            cannot be changed.</p>
          minimum: 1
          example: null
        free_quantity:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: |
            Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
          minimum: 0
          example: null
        free_quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The quantity of the item that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/getting-started)
            is enabled.
          maxLength: 33
          example: null
        channel:
          type: string
          deprecated: false
          description: |
            The subscription channel this object originated from and is maintained in.
            \* web -

            The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
            \* app_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.
            \* play_store -

            The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions)
            created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
          enum:
          - web
          - app_store
          - play_store
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this item price was last updated
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this item price was created
          example: null
        usage_accumulation_reset_frequency:
          type: string
          deprecated: false
          description: |
            null
          enum:
          - never
          - subscription_billing_frequency
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of the item.
            \* plan -

            An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription.
            \* charge -

            A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge)
            without being applied to a subscription.
            \* addon -

            A recurring component that can be added to a subscription in addition to its plan.
          enum:
          - plan
          - addon
          - charge
          example: null
        is_shippable:
          type: boolean
          default: false
          deprecated: false
          description: |
            Indicates that the item is a physical product. If Orders are enabled in Chargebee, subscriptions created for this item will have orders associated with them.
          example: null
        giftable:
          type: boolean
          default: false
          deprecated: false
          description: |
            Specifies if gift subscriptions can be created for this item.
          example: null
        redirect_url:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">enabled_for_checkout</code>
            , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.</p>
          maxLength: 500
          example: null
        enabled_for_checkout:
          type: boolean
          default: true
          deprecated: false
          description: |
            Allow the plan to subscribed to via Checkout. Applies only for plan-items.
          example: null
        enabled_in_portal:
          type: boolean
          default: true
          deprecated: false
          description: |
            Allow customers to change their subscription to this plan via the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html).
            Applies only for plan-items. This requires the Portal configuration to [allow changing subscriptions](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription)
            .
          example: null
        included_in_mrr:
          type: boolean
          deprecated: false
          description: |-
            <p class="mb-2">The item is included in MRR calculations for your site. This attribute is only applicable for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type = charge</code>
            and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            .</p>
          example: null
        item_applicability:
          type: string
          default: all
          deprecated: false
          description: |-
            <p class="mb-2">Indicates which addon-items and charge-items can be applied to the item. Only meant for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the <a href="/docs/api/attached_items/create-an-attached-item">Create</a>
            or <a href="/docs/api/attached_items/update-an-attached-item">Update an attached item</a>
            API.</p>
            * all - <p class="mb-2">all addon-items and charge-items are applicable to this plan-item.</p>
            * restricted - <p class="mb-2">only the addon-items or charge-items provided in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">applicable_items</code>
            can be applied to this plan-item.</p>
          enum:
          - all
          - restricted
          example: null
        gift_claim_redirect_url:
          type: string
          deprecated: false
          description: |
            The URL to redirect to once the gift has been claimed by the receiver.
          maxLength: 500
          example: null
        unit:
          type: string
          deprecated: false
          description: |
            The unit of measure for a quantity-based item. This is displayed on the Chargebee UI and on customer facing documents/pages. The latter includes [hosted pages](/docs/api/hosted_pages)
            , [invoices](/docs/api/invoices)
            and [quotes](/docs/api/quotes).
            Examples follow:

            * "user" for a cloud-collaboration platform.
            * "GB" for a data service.
            * "issue" for a magazine.
          maxLength: 30
          example: null
        item_name:
          type: string
          deprecated: false
          description: |
            Name of the items.
          maxLength: 50
          example: null
        item_description:
          type: string
          deprecated: false
          description: |
            Description of the item. This is visible only in Chargebee and not to customers.
          maxLength: 500
          example: null
        item_updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the item was last updated.
          example: null
        applicable_item_id:
          type: string
          deprecated: false
          description: |
            Id of the addon-item or plan-item that can be applied to the plan-item.
          maxLength: 100
          example: null
        sku:
          type: string
          deprecated: false
          description: |
            This maps to the sku or product name in the accounting integration.
          maxLength: 100
          example: null
        accounting_code:
          type: string
          deprecated: false
          description: |
            The identifier of the chart of accounts under which the item price falls in the accounting system.
          maxLength: 100
          example: null
        accounting_category1:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/2.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, provide the category name and option. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">:</code> . For example:<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: Singapore.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::...</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Services : Plan.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Locations, provide the name of the Location here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category2:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/2.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/xero.html " target="_blank"><strong class="font-semibold">Xero:</strong></a> If you&#x27;ve categorized your products in Xero, then provide the second category name and option here. Use the format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: ....</code> For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Region: South</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/quickbooks.html " target="_blank"><strong class="font-semibold">QuickBooks:</strong></a> If you&#x27;ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">::....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Location: North America: Canada</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">NA:US:CA</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.</li>
            </ul>
            <span featureId="cb-quickbooks-integration, cb-xero-integration" isMicro="true"></span>
          maxLength: 100
          example: null
        accounting_category3:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Used exclusively with the following <a href="https://www.chargebee.com/docs/2.0/finance-integration-index.html " target="_blank">accounting integrations</a></p>
            <ul class="list-disc list-outside ml-6 my-4 space-y-2">
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/netsuite.html " target="_blank"><strong class="font-semibold">NetSuite:</strong></a> If you&#x27;ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">: : ....</code> For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">Production: Assembly.</code></li>
            <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/intacct.html " target="_blank"><strong class="font-semibold">Intacct:</strong></a> If you&#x27;ve classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.</li>
            </ul>
          maxLength: 100
          example: null
        accounting_category4:
          type: string
          deprecated: false
          description: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )

            * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite.
            * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product.
          maxLength: 100
          example: null
        tax_profile_id:
          type: string
          deprecated: false
          description: |
            The tax profile of the item price.
          maxLength: 50
          example: null
        avalara_sale_type:
          type: string
          deprecated: false
          description: |
            Indicates the [Avalara sale type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)
            for the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)
            .
            \* retail -

            Transaction is a sale to an end user
            \* vendor_use -

            Transaction is for an item that is subject to vendor use tax
            \* consumed -

            Transaction is for an item that is consumed directly
            \* wholesale -

            Transaction is a sale to another company that will resell your product or service to another consumer
          enum:
          - wholesale
          - retail
          - consumed
          - vendor_use
          example: null
        avalara_transaction_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the [Avalara transaction type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)
            for the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)
            .
          example: null
        avalara_service_type:
          type: integer
          format: int32
          deprecated: false
          description: |
            Indicates the [Avalara service type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)
            for the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)
            .
          example: null
        avalara_tax_code:
          type: string
          deprecated: false
          description: |
            The [Avalara tax codes](https://taxcode.avatax.avalara.com)
            for the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avatax-for-sales.html)
            .
          maxLength: 50
          example: null
        hsn_code:
          type: string
          deprecated: false
          description: |
            The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)
            to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:

            * [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
            * The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
          maxLength: 50
          example: null
        taxjar_product_code:
          type: string
          deprecated: false
          description: |
            The [TaxJar product code](https://developers.taxjar.com/api/reference/#get-list-tax-categories)
            for the item price. Applicable only if you use [TaxJar integration](https://www.chargebee.com/docs/2.0/taxjar.html)
            .
          maxLength: 50
          example: null
        setup_cost:
          type: integer
          format: int64
          deprecated: false
          description: |
            One-time setup fee charged as part of the first invoice.
          minimum: 1
          example: null
        addon_applicability:
          type: string
          default: all
          deprecated: false
          description: |
            Indicates if all or only some addons are applicable with the plan.
            \* all -

            All addons are applicable with this plan.
            \* restricted -

            Only addons marked as 'applicable_addons' are applicable with the plan.
          enum:
          - all
          - restricted
          example: null
        charge_type:
          type: string
          default: recurring
          deprecated: false
          description: |
            Type of charge
            \* non_recurring -

            Charged immediately and only once every time it is applied.
            \* recurring -

            Charges are automatically applied in sync with the billing frequency of subscription.
          enum:
          - recurring
          - non_recurring
          example: null
        item_model:
          type: boolean
          deprecated: false
          description: |
            If enabled indicates that the particular site is on new Item model, else on old model
          example: null
      required:
      - addon_applicability
      - charge_type
      - created_at
      - enabled_for_checkout
      - enabled_in_portal
      - free_quantity
      - giftable
      - id
      - item_model
      - item_name
      - name
      - pricing_model
      - type
      example: null
    TimeMachine:
      type: object
      description: |
        Time Machine is a simulation feature which imitates the key characteristics, behaviours and functions of the billing configurations. It is a virtual time travelling tool which facilitates the integration testing process by carrying out subscription renewals, dunning, webhooks etc on a hypothetical time frame.

        You can use Time Machine in the test site to verify if the billing rules configured in your site adhere to your expectations before executing them in real time. This feature can be used in both API and UI versions.

        View this [doc](https://www.chargebee.com/docs/time-machine.html) for more details.

        **Note:** In order to use Time Machine via API , you need to first "enable" the Time Travel option which is available under **Settings** \> **Configure Chargebee** \> **Time Machine**.
      properties:
        name:
          type: string
          default: delorean
          deprecated: false
          description: |
            The name of the time machine. Currently only **delorean**
            is allowed
          maxLength: 50
          example: null
        time_travel_status:
          type: string
          default: not_enabled
          deprecated: false
          description: |
            The current status of time travel
            \* succeeded -

            Time travel has succeeded.
            \* not_enabled -

            Time travel has not been enabled for the site
            \* failed -

            Time travel has failed. Check the failure code and failure reason attributes for further details.
            **Note:**
            The time machine needs to be reset by starting afresh again.
            \* in_progress -

            Time travel is in progress
          enum:
          - not_enabled
          - in_progress
          - succeeded
          - failed
          example: null
        genesis_time:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The start time of the time machine. Specified when 'starting afresh'
          example: null
        destination_time:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The destination time to which the time machine is travelling (or has traveled)
          example: null
        failure_code:
          type: string
          deprecated: false
          description: |
            The failure code. This will follow the api error code convention
          maxLength: 250
          example: null
        failure_reason:
          type: string
          deprecated: false
          description: |
            The more descriptive failure reason.
          maxLength: 250
          example: null
        error_json:
          type: string
          deprecated: false
          description: |
            The failure details as error json.
          maxLength: 1000
          example: null
      required:
      - destination_time
      - genesis_time
      - name
      - time_travel_status
      example: null
    Token:
      type: object
      description: |
        Tokenization holds sensitive payment information into a unique token for a secure transaction. The token does not expose any actual payment details.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Identifier of the Chargebee Token
          maxLength: 40
          example: null
        gateway:
          type: string
          deprecated: false
          description: |
            Name of the gateway this token is stored in.
            \* twikey -

            Twikey is a payment service provider that specializes in processing direct debit payments across the EU.
            \* bluesnap -

            BlueSnap is a payment gateway.
            \* tco -

            2Checkout is a payment gateway.
            \* first_data_global -

            First Data Global Gateway Virtual Terminal Account
            \* exact -

            Exact Payments is a payment gateway.
            \* bluepay -

            BluePay is a payment gateway.
            \* paypal_express_checkout -

            PayPal Express Checkout is a payment gateway.
            \* eway -

            eWAY Account is a payment gateway.
            \* paypal_payflow_pro -

            PayPal Payflow Pro is a payment gateway.
            \* razorpay -

            Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
            \* global_payments -

            Global Payments is a payment service provider.
            \* amazon_payments -

            Amazon Payments is a payment service provider.
            \* not_applicable -

            Indicates that payment gateway is not applicable for this resource.
            \* checkout_com -

            Checkout.com is a payment gateway.
            \* adyen -

            Adyen is a payment gateway.
            \* braintree -

            Braintree is a payment gateway.
            \* nmi -

            NMI is a payment gateway.
            \* quickbooks -

            Intuit QuickBooks Payments gateway
            \* wepay -

            WePay is a payment gateway.
            \* worldpay -

            WorldPay is a payment gateway
            \* wirecard -

            WireCard Account is a payment service provider.
            \* chargebee_payments -

            Chargebee Payments gateway
            \* sage_pay -

            Sage Pay is a payment gateway.
            \* moneris_us -

            Moneris USA is a payment gateway.
            \* pin -

            Pin is a payment gateway
            \* authorize_net -

            Authorize.net is a payment gateway
            \* elavon -

            Elavon Virtual Merchant is a payment solution.
            \* paypal_pro -

            PayPal Pro Account is a payment gateway.
            \* orbital -

            Chase Paymentech(Orbital) is a payment gateway.
            \* paypal -

            PayPal Commerce is a payment gateway.
            \* beanstream -

            Bambora(formerly known as Beanstream) is a payment gateway.
            \* hdfc -

            HDFC Account is a payment gateway.
            \* ingenico_direct -

            Worldline Online Payments is a payment gateway.
            \* ogone -

            Ingenico ePayments (formerly known as Ogone) is a payment gateway.
            \* migs -

            MasterCard Internet Gateway Service payment gateway.
            \* stripe -

            Stripe is a payment gateway.
            \* vantiv -

            Vantiv is a payment gateway.
            \* moneris -

            Moneris is a payment gateway.
            \* chargebee -

            Chargebee test gateway.
            \* eway_rapid -

            eWAY Rapid is a payment gateway.
            \* gocardless -

            GoCardless is a payment service provider.
            \* mollie -

            Mollie is a payment gateway.
            \* paymill -

            PAYMILL is a payment gateway.
            \* balanced_payments -

            Balanced is a payment gateway
            \* cybersource -

            CyberSource is a payment gateway.
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account in which this token is stored.
          maxLength: 50
          example: null
        payment_method_type:
          type: string
          deprecated: false
          description: "Type of payment method of the token.\n\\* google_pay -\n\n\
            Payments made via Google Pay.\n\\* pay_co -\n\nPayments made via PayCo\n\
            \\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments\
            \ made via UnionPay.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* bancontact\
            \ -\n\nPayments made via Bancontact Card.\n\\* netbanking_emandates -\n\
            \nNetbanking (eMandates) Payments.\n\\* trustly -\n\nTrustly\n\\* after_pay\
            \ -\n\nPayments made via Afterpay\n\\* alipay -\n\nPayments made via Alipay.\
            \  \nThis payment source is deprecated.\n\\* dotpay -\n\nPayments made\
            \ via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\\* sofort\
            \ -\n\nPayments made via Sofort.\n\\* direct_debit -\n\nRepresents bank\
            \ account for which the direct debit or ACH agreement/mandate is created.\n\
            \\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\
            \\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* electronic_payment_standard\
            \ -\n\nElectronic Payment Standard\n\\* grab_pay -\n\nPayments made via\
            \ GrabPay\n\\* card -\n\nCard based payment including credit cards and\
            \ debit cards. Details about the card can be obtained from the card resource.\n\
            \\* upi -\n\nUPI Payments.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay\
            \ -\n\nPayments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\
            \\* twint -\n\nPayments made via Twint\n\\* generic -\n\nPayments made\
            \ via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\
            \\* wechat_pay -\n\nPayments made via WeChat Pay.  \nThis payment source\
            \ is deprecated.\n\\* kbc_payment_button -\n\nKBC Payment Button\n"
          enum:
          - card
          - paypal_express_checkout
          - amazon_payments
          - direct_debit
          - generic
          - alipay
          - unionpay
          - apple_pay
          - wechat_pay
          - ideal
          - google_pay
          - sofort
          - bancontact
          - giropay
          - dotpay
          - upi
          - netbanking_emandates
          - venmo
          - pay_to
          - faster_payments
          - sepa_instant_transfer
          - automated_bank_transfer
          - klarna_pay_now
          - online_banking_poland
          - payconiq_by_bancontact
          - electronic_payment_standard
          - kbc_payment_button
          - pay_by_bank
          - trustly
          - stablecoin
          - kakao_pay
          - naver_pay
          - revolut_pay
          - cash_app_pay
          - twint
          - go_pay
          - grab_pay
          - pay_co
          - after_pay
          - swish
          - payme
          - pix
          - klarna
          example: null
        status:
          type: string
          default: new
          deprecated: false
          description: |
            Status of the token
            \* new -

            new
            \* consumed -

            The token is already used
            \* expired -

            expired
          enum:
          - new
          - expired
          - consumed
          example: null
        id_at_vault:
          type: string
          deprecated: false
          description: |
            The id with which this token is referred in gateway
          maxLength: 65000
          example: null
        vault:
          type: string
          deprecated: false
          description: |
            Name of the gateway/vault provider where the payment method is tokenized
            \* gateway -

            gateway
            \* spreedly -

            spreedly
          enum:
          - spreedly
          - gateway
          example: null
        ip_address:
          type: string
          deprecated: false
          description: |
            The IP address from where the token is created. Used primarily for EU VAT validation.
          maxLength: 50
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this token resource was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this token resource is created.
          example: null
        expired_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this token is expired
          example: null
      required:
      - created_at
      - gateway
      - gateway_account_id
      - id
      - id_at_vault
      - payment_method_type
      - status
      - vault
      example: null
    TokenConsumedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            token:
              $ref: "#/components/schemas/Token"
          required:
          - token
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TokenCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            token:
              $ref: "#/components/schemas/Token"
          required:
          - token
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TokenExpiredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            token:
              $ref: "#/components/schemas/Token"
          required:
          - token
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Transaction:
      type: object
      description: |
        This resource represents the [transaction](https://www.chargebee.com/docs/transactions.html)
        event that has happened in your account.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies the transaction.
          maxLength: 40
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer for which this transaction is made
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            Identifier of the subscription for which this transaction is made.
          maxLength: 50
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account used for this transaction
          maxLength: 50
          example: null
        payment_source_id:
          type: string
          deprecated: false
          description: |
            Identifier of the payment source for which this transaction is made
          maxLength: 40
          example: null
        payment_method:
          type: string
          default: card
          deprecated: false
          description: |-
            <p class="mb-2">The payment method of this transaction</p>
            * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p>
            <span featureId="cb-naver-pay" isMicro="true"></span>
            * unionpay - <p class="mb-2">Unionpay</p>
            * online_banking_poland - <p class="mb-2">Online Banking Poland</p>
            <span featureId="cb-online-banking-poland" isMicro="true"></span>
            * upi - <p class="mb-2">upi</p>
            * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p>
            <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span>
            * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p>
            <span featureId="cb-kakao-pay" isMicro="true"></span>
            * check - <p class="mb-2">Check</p>
            * payme - <p class="mb-2">Payments made via PayMe</p>
            <span featureId="cb-payme" isMicro="true"></span>
            * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p>
            <span featureId="cb-cash-app-pay" isMicro="true"></span>
            * custom - <p class="mb-2">Custom</p>
            * amazon_payments - <p class="mb-2">Amazon Payments</p>
            * boleto - <p class="mb-2">boleto</p>
            * direct_debit - <p class="mb-2">Direct Debit</p>
            * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p>
            <span featureId="cb-klarna-pay-now" isMicro="true"></span>
            * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p>
            <span featureId="cb-sepa-instant-transfer" isMicro="true"></span>
            * apple_pay - <p class="mb-2">Apple Pay</p>
            * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p>
            <span featureId="cb-wechat-pay" isMicro="true"></span>
            * twint - <p class="mb-2">Payments made via Twint</p>
            <span featureId="cb-twint" isMicro="true"></span>
            * kbc_payment_button - <p class="mb-2">KBC Payment Button</p>
            * bancontact - <p class="mb-2">Bancontact</p>
            * faster_payments - <p class="mb-2">Faster Payments</p>
            <span featureId="cb-faster-payments" isMicro="true"></span>
            * go_pay - <p class="mb-2">Payments made via GoPay</p>
            <span featureId="cb-go-pay" isMicro="true"></span>
            * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p>
            <span featureId="cb-stablecoin" isMicro="true"></span>
            * venmo - <p class="mb-2">Venmo</p>
            <span featureId="cb-venmo" isMicro="true"></span>
            * bank_transfer - <p class="mb-2">Bank Transfer</p>
            * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p>
            * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p>
            * other - <p class="mb-2">Payment Methods other than the above types</p>
            * trustly - <p class="mb-2">Trustly</p>
            * ach_credit - <p class="mb-2">ACH Credit</p>
            * sepa_credit - <p class="mb-2">SEPA Credit</p>
            * card - <p class="mb-2">Card</p>
            * ideal - <p class="mb-2">IDEAL</p>
            * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</a></code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>.
            This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a>
            occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a>
            .</p>
            * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p>
            <span featureId="cb-bank-transfer" isMicro="true"></span>
            * google_pay - <p class="mb-2">Google Pay</p>
            * netbanking_emandates - <p class="mb-2">netbanking_emandates</p>
            * pay_to - <p class="mb-2">PayTo</p>
            <span featureId="cb-pay-to" isMicro="true"></span>
            * pay_by_bank - <p class="mb-2">Pay By Bank</p>
            * dotpay - <p class="mb-2">Dotpay</p>
            * alipay - <p class="mb-2">Payments made via Alipay.</p>
            <span featureId="cb-alipay" isMicro="true"></span>
            * sofort - <p class="mb-2">Sofort</p>
            * swish - <p class="mb-2">Payments made via Swish</p>
            <span featureId="cb-swish" isMicro="true"></span>
            * grab_pay - <p class="mb-2">Payments made via GrabPay</p>
            <span featureId="cb-grab-pay" isMicro="true"></span>
            * pix - <p class="mb-2">Pix</p>
            <span featureId="cb-pix" isMicro="true"></span>
            * giropay - <p class="mb-2">giropay</p>
            * pay_co - <p class="mb-2">Payments made via PayCo</p>
            <span featureId="cb-pay-co" isMicro="true"></span>
            * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p>
            <span featureId="cb-revolut-pay" isMicro="true"></span>
            * cash - <p class="mb-2">Cash</p>
            * after_pay - <p class="mb-2">Payments made via Afterpay</p>
            <span featureId="cb-after-pay" isMicro="true"></span>
          enum:
          - card
          - cash
          - check
          - chargeback
          - bank_transfer
          - amazon_payments
          - paypal_express_checkout
          - direct_debit
          - alipay
          - unionpay
          - apple_pay
          - wechat_pay
          - ach_credit
          - sepa_credit
          - ideal
          - google_pay
          - sofort
          - bancontact
          - giropay
          - dotpay
          - other
          - upi
          - netbanking_emandates
          - custom
          - boleto
          - venmo
          - pay_to
          - faster_payments
          - sepa_instant_transfer
          - automated_bank_transfer
          - klarna_pay_now
          - online_banking_poland
          - payconiq_by_bancontact
          - electronic_payment_standard
          - kbc_payment_button
          - pay_by_bank
          - trustly
          - stablecoin
          - kakao_pay
          - naver_pay
          - revolut_pay
          - cash_app_pay
          - pix
          - twint
          - go_pay
          - grab_pay
          - pay_co
          - after_pay
          - swish
          - payme
          - klarna
          example: null
        reference_number:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code>
            .</p>
          maxLength: 100
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Gateway through which this transaction was done. Applicable\
            \ only for 'Card' Payment Method\n\\* bluesnap -\n\nBlueSnap is a payment\
            \ gateway.\n\\* jp_morgan -\n\nJ.P. Morgan Mobility Payment Solutions\
            \ is a payment gateway that enables you to securely accept and manage\
            \ digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type).\
            \  \nThis feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature)\
            \ to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL\
            \ for your test and live sites.\n\\* tco -\n\n2Checkout is a payment gateway.\n\
            \\* razorpay -\n\nRazorpay is a fast growing payment service provider\
            \ in India working with all leading banks and support for major local\
            \ payment methods including Netbanking, UPI etc.\n\\* dlocal -\n\nDlocal\
            \ provides payment solutions for global commerce by accepting local payment\
            \ methods.\n\\* checkout_com -\n\nCheckout.com is a payment gateway.\n\
            \\* adyen -\n\nAdyen is a payment gateway.\n\\* braintree -\n\nBraintree\
            \ is a payment gateway.\n\\* paystack -\n\nPaystack is a payment gateway\
            \ for businesses in Africa. It enables secure payment acceptance both\
            \ online and offline.  \nThis feature is a **Private Beta Release** .\
            \ [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
            \ to enable Paystack for your test and live sites.\n\\* pay_com -\n\n\
            Pay.com provides payment services focused on simplicity and hassle-free\
            \ operations for businesses of all sizes.\n\\* moneris_us -\n\nMoneris\
            \ USA is a payment gateway.\n\\* pin -\n\nPin is a payment gateway\n\\\
            * moneris -\n\nMoneris is a payment gateway.\n\\* chargebee -\n\nChargebee\
            \ test gateway.\n\\* cybersource -\n\nCyberSource is a payment gateway.\n\
            \\* ecentric -\n\nEcentric provides a seamless payment processing service\
            \ in South Africa specializing on omnichannel capabilities.\n\\* first_data_global\
            \ -\n\nFirst Data Global Gateway Virtual Terminal Account\n\\* exact -\n\
            \nExact Payments is a payment gateway.\n\\* nuvei -\n\nNuvei is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \nThis\
            \ feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
            \ to enable Nuvei for your test and live sites.\n\\* eway -\n\neWAY Account\
            \ is a payment gateway.\n\\* amazon_payments -\n\nAmazon Payments is a\
            \ payment service provider.\n\\* sage_pay -\n\nSage Pay is a payment gateway.\n\
            \\* elavon -\n\nElavon Virtual Merchant is a payment solution.\n\\* orbital\
            \ -\n\nChase Paymentech(Orbital) is a payment gateway.\n\\* beanstream\
            \ -\n\nBambora(formerly known as Beanstream) is a payment gateway.\n\\\
            * hdfc -\n\nHDFC Account is a payment gateway.\n\\* bank_of_america -\n\
            \nBank of America Gateway\n\\* gocardless -\n\nGoCardless is a payment\
            \ service provider.\n\\* paymill -\n\nPAYMILL is a payment gateway.\n\\\
            * balanced_payments -\n\nBalanced is a payment gateway\n\\* twikey -\n\
            \nTwikey is a payment service provider that specializes in processing\
            \ direct debit payments across the EU.\n\\* deutsche_bank -\n\nDeutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \nThis feature is a **Private Beta Release**.\n\\* bluepay\
            \ -\n\nBluePay is a payment gateway.\n\\* paypal_express_checkout -\n\n\
            PayPal Express Checkout is a payment gateway.\n\\* paypal_payflow_pro\
            \ -\n\nPayPal Payflow Pro is a payment gateway.\n\\* global_payments -\n\
            \nGlobal Payments is a payment service provider.\n\\* not_applicable -\n\
            \nIndicates that payment gateway is not applicable for this resource.\n\
            \\* nmi -\n\nNMI is a payment gateway.\n\\* worldpay -\n\nWorldPay is\
            \ a payment gateway\n\\* authorize_net -\n\nAuthorize.net is a payment\
            \ gateway\n\\* stripe -\n\nStripe is a payment gateway.\n\\* metrics_global\
            \ -\n\nMetrics global is a leading payment service provider providing\
            \ unified payment services in the US.\n\\* windcave -\n\nWindcave provides\
            \ an end to end payment processing solution in ANZ and other leading global\
            \ markets.\n\\* quickbooks -\n\nIntuit QuickBooks Payments gateway\n\\\
            * wepay -\n\nWePay is a payment gateway.\n\\* ezidebit -\n\nEzidebit is\
            \ a payment gateway integration based in Australia that supports automated\
            \ direct debit, BPAY, and card payments for businesses.  \nThis feature\
            \ is a **Private Beta Release**.\n\\* wirecard -\n\nWireCard Account is\
            \ a payment service provider.\n\\* chargebee_payments -\n\nChargebee Payments\
            \ gateway\n\\* paypal_pro -\n\nPayPal Pro Account is a payment gateway.\n\
            \\* paypal -\n\nPayPal Commerce is a payment gateway.\n\\* ingenico_direct\
            \ -\n\nWorldline Online Payments is a payment gateway.\n\\* ogone -\n\n\
            Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n\\\
            * migs -\n\nMasterCard Internet Gateway Service payment gateway.\n\\*\
            \ vantiv -\n\nVantiv is a payment gateway.\n\\* eway_rapid -\n\neWAY Rapid\
            \ is a payment gateway.\n\\* mollie -\n\nMollie is a payment gateway.\n\
            \\* solidgate -\n\nSolidgate is a secure and reliable payment processing\
            \ solution that allows you to accept payments from customers and suitable\
            \ for various types of businesses.  \nThis feature is a **Private Beta\
            \ Release**.\n\\* ebanx -\n\nEBANX is a payment gateway, enabling businesses\
            \ to accept diverse local payment methods from various countries for increased\
            \ market reach and conversion.\n"
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Type of the transaction.</p>
            * authorization - <p class="mb-2">The transaction represents an authorization for capturing the <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
            from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
            .</p>
            * payment - <p class="mb-2">The transaction represents capture of <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
            from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
            .</p>
            * refund - <p class="mb-2">The transaction represents a refund of <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code>
            to the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code>
            .</p>
            * payment_reversal - <p class="mb-2">Indicates a reversal transaction.</p>
          enum:
          - authorization
          - payment
          - refund
          - payment_reversal
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates when this transaction occurred.
          example: null
        settled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates the time at which the final status of the transaction has been marked.
          example: null
        exchange_rate:
          type: number
          format: decimal
          deprecated: false
          description: |
            Exchange rate used for base currency conversion
          maximum: 1000000000
          minimum: 0.0000000010
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the transaction.
          maxLength: 3
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Amount for this transaction.
          minimum: 0
          example: null
        id_at_gateway:
          type: string
          deprecated: false
          description: |
            The id with which this transaction is referred in gateway.
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The status of this transaction.</p>
            * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
            or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
            * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
            * success - <p class="mb-2">The transaction is successful.</p>
            * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
            * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
            status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
            You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
            (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
            for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
            transaction to be reconciled at par with the gateway.</p>
            <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
            about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
            transaction status</p></div>
            * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
            * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
          enum:
          - in_progress
          - success
          - voided
          - failure
          - timeout
          - needs_attention
          - late_failure
          example: null
        fraud_flag:
          type: string
          deprecated: false
          description: |
            Indicates whether or not the transaction has been identified as fraudulent.
            \* suspicious -

            The transaction has been identified as potentially fraudulent by the gateway
            \* safe -

            The transaction has been marked as safe
            \* fraudulent -

            The transaction has been marked as fraudulent
          enum:
          - safe
          - suspicious
          - fraudulent
          example: null
        initiator_type:
          type: string
          deprecated: false
          description: |
            Marker for on-session payments (3DS). null indicates 'merchant'.
            \* merchant -

            Payment initiated on stored payment method by the merchant
            \* customer -

            Customer initiated 3DS payment
          enum:
          - customer
          - merchant
          example: null
        three_d_secure:
          type: boolean
          deprecated: false
          description: |
            Indicates whether this transaction has gone through 3DS. Applicable only for 'on-session' payments \& verifications.If 3DS is not enforced by the gateway/bank or if the customers' card is not enrolled, this will be false.
          example: null
        authorization_reason:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Type of authorization transaction.</p>
            * scheduled_capture - <p class="mb-2">The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under <code><a href="">linked_payments</a></code>
            .</p>
            * verification - <p class="mb-2">The transaction has been created for payment method verification.</p>
            * blocking_funds - <p class="mb-2">The transaction has been created to block the funds from payment method.</p>
          enum:
          - blocking_funds
          - verification
          - scheduled_capture
          example: null
        error_code:
          type: string
          deprecated: false
          description: |
            Error code received from the payment gateway on failure.
          maxLength: 100
          example: null
        error_text:
          type: string
          deprecated: false
          description: |
            Error message received from the payment gateway on failure.
          maxLength: 65000
          example: null
        voided_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the payment was voided or authorization expired at gateway.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this transaction was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
          example: null
        fraud_reason:
          type: string
          deprecated: false
          description: |
            Short description why the transaction was marked as fraud/suspicious
          maxLength: 250
          example: null
        custom_payment_method_id:
          type: string
          deprecated: false
          description: |
            Identifier of the custom payment method of this transaction.
          maxLength: 50
          example: null
        amount_unused:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">This is the part of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount</code>
            which has not been invoiced yet and is therefore added to <code><a href="/docs/api/customers/customer-object#excess_payments">excess_payments</a></code>
            for the customer. Applicable only for a transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>
            .</p>
          minimum: 0
          example: null
        masked_card_number:
          type: string
          deprecated: false
          description: |
            The masked card number used for this transaction. Applicable only for 'Card' Payment Method
          maxLength: 20
          example: null
        reference_transaction_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the offline transaction that is being refunded or reversed. Applicable only for transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>
            or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_reversal</code>
            .</p>
          maxLength: 40
          example: null
        refunded_txn_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the transaction (always of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>
            ) being refunded. Applicable only for transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund</code>
            .</p>
          maxLength: 40
          example: null
        reference_authorization_id:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">This is the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code>
            of the transaction (always of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">authorization</code>
            ) which authorizes the payment being captured. Applicable only for transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>
            .</p>
          maxLength: 40
          example: null
        amount_capturable:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">This is the part of the authorized <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount</code>
            that is yet to be captured. The payment capture is recorded as a transaction of of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment</code>.
            Applicable only for a transaction of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code>
            = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">authorization</code>
            .</p>
          minimum: 0
          example: null
        reversal_transaction_id:
          type: string
          deprecated: false
          description: |
            Reversal transaction id. Applicable only for payment transactions.
          maxLength: 40
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        iin:
          type: string
          deprecated: false
          description: |
            First 6 digits of the card payment method.
          maxLength: 6
          minLength: 4
          example: null
        last4:
          type: string
          deprecated: false
          description: |
            Last 4 digits of the transaction.
          maxLength: 4
          minLength: 4
          example: null
        merchant_reference_id:
          type: string
          deprecated: false
          description: |
            A unique id used to track this transaction across various systems you integrate with. This id is passed to the payment gateway when the transaction is initiated. Supported only for the [Exact payment gateway](https://www.chargebee.com/docs/exact-direct.html)
            .
          maxLength: 500
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        payment_method_details:
          type: string
          deprecated: false
          description: |
            Payment method details of the corresponding transaction
          example: null
        custom_payment_method_name:
          type: string
          deprecated: false
          description: |
            Name of the custom payment method of this transaction.
          maxLength: 100
          example: null
        linked_invoices:
          type: array
          deprecated: false
          description: |
            Applicable only for 'Payment' transactions. The list of invoices this 'payment' transaction is applied to.
          items:
            type: object
            deprecated: false
            properties:
              invoice_id:
                type: string
                deprecated: false
                description: |
                  Identifier for the invoice.
                maxLength: 50
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The transaction amount applied to this invoice
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp at which the transaction is applied.
                example: null
              invoice_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date this invoice is issued.
                example: null
              invoice_total:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Total amount of the invoice
                minimum: 0
                example: null
              invoice_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">Current status of this invoice.</p>
                  * pending - <p class="mb-2">The <a href="/docs/api/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when it has line items that belong to items that are <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> or when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription.create_pending_invoices</code>attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.
                  The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site.</p>
                  * voided - <p class="mb-2">Indicates a voided invoice.</p>
                  * payment_due - <p class="mb-2">Indicates the payment is not yet collected and is being retried as per retry settings.</p>
                  * paid - <p class="mb-2">Indicates a paid invoice.</p>
                  * posted - <p class="mb-2">Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period</p>
                  * not_paid - <p class="mb-2">Indicates the payment is not made and all attempts to collect is failed.</p>
                enum:
                - paid
                - posted
                - payment_due
                - not_paid
                - voided
                - pending
                example: null
            required:
            - applied_amount
            - applied_at
            - invoice_id
            - invoice_status
            example: null
          example: null
        linked_credit_notes:
          type: array
          deprecated: false
          description: |
            Applicable only for 'Refund' transactions. The list of Credit Notes this 'refund' transaction is associated with.
          items:
            type: object
            deprecated: false
            properties:
              cn_id:
                type: string
                deprecated: false
                description: |
                  Identifier for the credit-notes.
                maxLength: 50
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The transaction amount applied to this invoice
                minimum: 0
                example: null
              applied_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp at which the transaction is applied.
                example: null
              cn_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code. Deprecated use the cn_create_reason_code parameter instead
                  \* service_unsatisfactory -

                  Service Unsatisfactory
                  \* other -

                  Can be set when none of the above reason codes are applicable
                  \* subscription_cancellation -

                  This reason will be set automatically for Credit Notes created during cancel subscription operation
                  \* fraudulent -

                  FRAUDULENT
                  \* order_change -

                  Order Change
                  \* subscription_pause -

                  This reason will be automatically set to credit notes created during pause/resume subscription operation.
                  \* write_off -

                  This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)
                  operation.
                  \* subscription_change -

                  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)
                  is enabled
                  \* chargeback -

                  Can be set when you are recording your customer Chargebacks
                  \* waiver -

                  Waiver
                  \* order_cancellation -

                  Order Cancellation
                  \* product_unsatisfactory -

                  Product Unsatisfactory
                enum:
                - write_off
                - subscription_change
                - subscription_cancellation
                - subscription_pause
                - chargeback
                - product_unsatisfactory
                - service_unsatisfactory
                - order_change
                - order_cancellation
                - waiver
                - other
                - fraudulent
                example: null
              cn_create_reason_code:
                type: string
                deprecated: false
                description: |
                  Credit note reason code
                maxLength: 100
                example: null
              cn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date this credit note is created.
                example: null
              cn_total:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Total amount of the credit note
                minimum: 0
                example: null
              cn_status:
                type: string
                deprecated: false
                description: |
                  The status of this Credit Note.
                  \* voided -

                  When the Credit Note has been cancelled.
                  \* refund_due -

                  When the credits are yet to be used, or have been partially used.
                  \* refunded -

                  When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).
                  \* adjusted -

                  When the Credit Note has been adjusted against an invoice.
                enum:
                - adjusted
                - refunded
                - refund_due
                - voided
                example: null
              cn_reference_invoice_id:
                type: string
                deprecated: false
                description: |
                  The invoice number. Acts as a identifier for invoice and typically generated sequentially.
                maxLength: 50
                example: null
            required:
            - applied_amount
            - applied_at
            - cn_id
            - cn_status
            example: null
          example: null
        linked_refunds:
          type: array
          deprecated: false
          description: |
            Applicable only for Payment transactions. It only returns values when the transaction is not associated with an invoice, and that there is a refund for the transaction.
          items:
            type: object
            deprecated: false
            properties:
              txn_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the transaction.
                maxLength: 40
                example: null
              txn_status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of this transaction.</p>
                  * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                  for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                  transaction to be reconciled at par with the gateway.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transaction status</p></div>
                  * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                  * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                  * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                  * success - <p class="mb-2">The transaction is successful.</p>
                  * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                  * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              txn_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates when this refund occured.
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Amount of this refund transaction.
                minimum: 0
                example: null
            required:
            - txn_amount
            - txn_date
            - txn_id
            - txn_status
            example: null
          example: null
        linked_payments:
          type: array
          deprecated: false
          description: |
            The list of payments captured for this authorization transaction.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the transaction.
                maxLength: 40
                example: null
              status:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The status of this transaction.</p>
                  * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/v2/pcv-1/transactions/reconcile-transaction">Reconcile transaction API</a>.
                  You can use this API to update the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id_at_gateway</code>
                  (Gateway Transaction ID) and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>
                  for a <a href="/docs/api/v2/pcv-1/transactions/transaction-object#status"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code></a>
                  transaction to be reconciled at par with the gateway.</p>
                  <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/1.0/needs-attention-transactions.html">Learn more</a>
                  about <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">needs_attention</code>
                  transaction status</p></div>
                  * success - <p class="mb-2">The transaction is successful.</p>
                  * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p>
                  * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a>
                  or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p>
                  * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>
                  * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p>
                  * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p>
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Amount for this transaction.
                minimum: 0
                example: null
              date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates when this transaction occurred.
                example: null
            required:
            - id
            example: null
          example: null
        error_detail:
          type: object
          deprecated: false
          description: |
            Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about \[gateway error references\](/docs/api/v2/pcv-1/gateway_error_references)
          properties:
            request_id:
              type: string
              deprecated: false
              description: |
                This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
              maxLength: 100
              example: null
            error_category:
              type: string
              deprecated: false
              description: |
                This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
              maxLength: 100
              example: null
            error_code:
              type: string
              deprecated: false
              description: |
                A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
              maxLength: 100
              example: null
            error_message:
              type: string
              deprecated: false
              description: |
                A message provided by the gateway that describes the nature of the error encountered
              maxLength: 65000
              example: null
            decline_code:
              type: string
              deprecated: false
              description: |
                When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
              maxLength: 100
              example: null
            decline_message:
              type: string
              deprecated: false
              description: |
                This message gives a descriptive explanation of the reason for the transaction's decline
              maxLength: 65000
              example: null
            network_error_code:
              type: string
              deprecated: false
              description: |
                This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
              maxLength: 100
              example: null
            network_error_message:
              type: string
              deprecated: false
              description: |
                This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered
              maxLength: 65000
              example: null
            error_field:
              type: string
              deprecated: false
              description: |
                This parameter indicates which specific data field or attribute in the request caused the error
              maxLength: 100
              example: null
            recommendation_code:
              type: string
              deprecated: false
              description: |
                After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
              maxLength: 100
              example: null
            recommendation_message:
              type: string
              deprecated: false
              description: |
                This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
              maxLength: 65000
              example: null
            processor_error_code:
              type: string
              deprecated: false
              description: |
                This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
              maxLength: 100
              example: null
            processor_error_message:
              type: string
              deprecated: false
              description: |
                This message describes the specific error that the payment processor encountered
              maxLength: 65000
              example: null
            error_cause_id:
              type: string
              deprecated: false
              description: |
                A [Chargebee-defined code](/docs/api/errors)
                that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
              maxLength: 150
              example: null
            processor_advice_code:
              type: string
              deprecated: false
              description: "<p class=\"mb-2\">An advice code from the payment gateway\
                \ or network that indicates how to handle a card decline. For example,\
                \ the value <code class=\"bg-gray-100 text-gray-800 font-medium border\
                \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
                >try_again_later</code> means you can retry the transaction.</p>"
              maxLength: 100
              example: null
          example: null
      required:
      - currency_code
      - deleted
      - gateway
      - id
      - payment_method
      - type
      example: null
    TransactionCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
          required:
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TransactionDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
          required:
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TransactionUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            transaction:
              $ref: "#/components/schemas/Transaction"
          required:
          - transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    TrialEndAction:
      type: string
      deprecated: false
      enum:
      - site_default
      - plan_default
      - activate_subscription
      - cancel_subscription
      example: null
    Type:
      type: string
      deprecated: false
      enum:
      - card
      - paypal_express_checkout
      - amazon_payments
      - direct_debit
      - generic
      - alipay
      - unionpay
      - apple_pay
      - wechat_pay
      - ideal
      - google_pay
      - sofort
      - bancontact
      - giropay
      - dotpay
      - upi
      - netbanking_emandates
      - venmo
      - pay_to
      - faster_payments
      - sepa_instant_transfer
      - automated_bank_transfer
      - klarna_pay_now
      - online_banking_poland
      - payconiq_by_bancontact
      - electronic_payment_standard
      - kbc_payment_button
      - pay_by_bank
      - trustly
      - stablecoin
      - kakao_pay
      - naver_pay
      - revolut_pay
      - cash_app_pay
      - twint
      - go_pay
      - grab_pay
      - pay_co
      - after_pay
      - swish
      - payme
      - pix
      - klarna
      - free_trial
      - pay_up_front
      - pay_as_you_go
      - usage_exceeded
      example: null
    UnbilledCharge:
      type: object
      description: "<div class=\"api-description\"><p class=\"mb-2\">Unbilled charge\
        \ represents the charges that are held by passing <code class=\"bg-gray-100\
        \ text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1\
        \ text-sm font-mono whitespace-nowrap\">invoice_immediately</code> in various\
        \ operations such as update subscription, add charge, create subscription,\
        \ etc. <a href=\"https://www.chargebee.com/docs/unbilled-charges.html\" target=\"\
        _blank\">Learn more.</a></p><p class=\"mb-2\">If any invoice is to be created\
        \ for a subscription all the unbilled charges associated with the subscription\
        \ will be included in that invoice.</p><p class=\"mb-2\">If any invoice is\
        \ to be created for a customer, all the unbilled charges associated with its\
        \ subscriptions will be included in that invoice.</p><p class=\"mb-2\">Any\
        \ automatic invoice creation like renewal, activation, etc., will include\
        \ the unbilled charges.</p><p class=\"mb-2\">Subscriptions are invoiced at\
        \ the start of every term based on the recurring items and charged immediately\
        \ against the customer&#x27;s credit card if &#x27;auto_collection&#x27; is\
        \ turned &#x27;on&#x27;, otherwise the resulting invoice will be created as\
        \ &#x27;Payment Due&#x27;.</p><p class=\"mb-2\">If consolidated invoicing\
        \ is enabled, the charges during the subscription renewals/activations will\
        \ be held and consolidated at the last renewal/activation that takes place\
        \ on that particular day.</p></div>"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies an unbilled charge.
          maxLength: 40
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the customer being charged.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the subscription this charge belongs to.
          maxLength: 50
          example: null
        date_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start date of this charge.
          example: null
        date_to:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End date of this charge.
          example: null
        unit_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Unit amount of the charge item.
          minimum: 0
          example: null
        pricing_model:
          type: string
          deprecated: false
          description: |
            The pricing scheme for this line item.
            \* tiered -

            There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
            \* per_unit -

            A fixed price per unit quantity.
            \* flat_fee -

            A fixed price that is not quantity-based.
            \* volume -

            The per unit price is based on the tier that the total quantity falls in.
            \* stairstep -

            A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
          enum:
          - flat_fee
          - per_unit
          - tiered
          - volume
          - stairstep
          example: null
        quantity:
          type: integer
          format: int32
          deprecated: false
          description: |
            Quantity of the item which is represented by this charge.
          minimum: 0
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total amount of this charge. Typically equals to unit amount x quantity.
          minimum: 0
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) for the charge.
          maxLength: 3
          example: null
        discount_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total discounts for this charge.
          minimum: 0
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Detailed description about this charge.
          maxLength: 250
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Specifies the modelled entity this line item is based on.
            \* plan_setup -

            Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
            id
            \* plan -

            Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)
            id
            \* addon_item_price -

            Indicates that this line item is based on addon Item Price
            \* plan_item_price -

            Indicates that this line item is based on plan Item Price
            \* adhoc -

            Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
            \* addon -

            Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)
            id
            \* charge_item_price -

            Indicates that this line item is based on charge Item Price
          enum:
          - plan_setup
          - plan
          - addon
          - adhoc
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
          maxLength: 100
          example: null
        is_voided:
          type: boolean
          default: false
          deprecated: false
          description: |
            Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
          example: null
        voided_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating the date and time this charge got voided.
          example: null
        unit_amount_in_decimal:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">The decimal representation of the amount for the charge, in major units of the currency. Typically equals to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">unit_amount_in_decimal</code>
            x <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity_in_decimal</code>.
            Returned when <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
            is enabled.</p>
          maxLength: 39
          example: null
        quantity_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 33
          example: null
        amount_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)
            is enabled.
          maxLength: 39
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the unbilled charge was created.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the unbilled charge was last updated
          example: null
        is_advance_charge:
          type: boolean
          default: false
          deprecated: false
          description: |
            The value of this parameter will be true if it is a recurring unbilled charge for a future term.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: "The ID of the business entity created for the site. For Product\
            \ Catalog 1.0, all the site data is tied to this business entity.  \n\
            **Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is\
            \ a feature available only on Product Catalog 2.0.\n"
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        tiers:
          type: array
          deprecated: false
          description: |
            The list of tiers applicable for this line item
          items:
            type: object
            deprecated: false
            properties:
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lower limit of a range of units for the tier
                minimum: 0
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The upper limit of a range of units for the tier
                example: null
              quantity_used:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The number of units purchased in a range.
                minimum: 0
                example: null
              unit_amount:
                type: integer
                format: int64
                deprecated: false
                description: |-
                  <p class="mb-2">The price of the tier if the charge model is a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairtstep</code>
                  pricing , or the price of each unit in the tier if the charge model is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  /<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  pricing.</p>
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ending_unit_in_decimal</code>
                  of the next lower tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">starting_unit_in_decimal</code>
                  of the next higher tier. Returned only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  , <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>
                  or stairstep and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the quantity purchased from this tier. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |-
                  <p class="mb-2">The decimal representation of the per-unit price for the tier when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">tiered</code>
                  or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">volume</code>.
                  When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pricing_model</code>
                  is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">stairstep</code>
                  , it is the decimal representation of the total price for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>.
                  The value is in major units of the currency. Returned when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_item</code>
                  is quantity-based and <a href="/docs/api/v2/pcv-1/currencies" target="_blank">multi-decimal pricing</a>
                  is enabled.</p>
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
            required:
            - quantity_used
            - starting_unit
            - unit_amount
            example: null
          example: null
      required:
      - currency_code
      - deleted
      - entity_type
      - is_voided
      - updated_at
      example: null
    UnbilledChargesCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    UnbilledChargesDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    UnbilledChargesHandling:
      type: string
      deprecated: false
      enum:
      - no_action
      - invoice
      example: null
    UnbilledChargesInvoicedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - invoice
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    UnbilledChargesMeta:
      type: object
      properties:
        count:
          type: integer
          format: int32
          default: 0
          deprecated: false
          example: null
        has_more:
          type: boolean
          default: false
          deprecated: false
          example: null
      required:
      - count
      - has_more
      example: null
    UnbilledChargesOption:
      type: string
      deprecated: false
      enum:
      - invoice
      - delete
      example: null
    UnbilledChargesVoidedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            unbilled_charges:
              type: array
              items:
                $ref: "#/components/schemas/UnbilledCharge"
              example: null
          required:
          - unbilled_charges
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    UnpaidInvoicesHandling:
      type: string
      deprecated: false
      enum:
      - no_action
      - schedule_payment_collection
      example: null
    UsageAccumulationResetFrequency:
      type: string
      deprecated: false
      enum:
      - never
      - subscription_billing_frequency
      example: null
    UsageEvent:
      type: object
      description: |
        This resource enables developers to send usage data to Chargebee for processing. This resource supports both individual usage events and batch ingestion of usage data. These endpoints are designed to handle a variety of use cases, such as usage-based billing, data ingestion for analytics, and more. The flexibility and scalability of these APIs ensure that they can adapt to your business's evolving needs.
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique identifier of a subscription entity.
          maxLength: 50
          example: null
        deduplication_id:
          type: string
          deprecated: false
          description: ""
          maxLength: 36
          example: null
        usage_timestamp:
          type: integer
          format: int64
          deprecated: false
          description: |
            Timestamp at which this usage occurred.
          example: null
        properties:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            List of attributes or dimension attributes defined in the meter.
          example: null
      required:
      - deduplication_id
      - properties
      - subscription_id
      - usage_timestamp
      example: null
    UsageFile:
      type: object
      description: |
        Represents a file containing usage events that has been uploaded for processing.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the usage file.
          maxLength: 36
          example: null
        name:
          type: string
          deprecated: false
          description: ""
          maxLength: 150
          example: null
        mime_type:
          type: string
          deprecated: false
          description: ""
          maxLength: 100
          example: null
        error_code:
          type: string
          deprecated: false
          description: ""
          maxLength: 50
          example: null
        error_reason:
          type: string
          deprecated: false
          description: ""
          maxLength: 500
          example: null
        status:
          type: string
          default: queued
          deprecated: false
          description: |
            Current status of the usage file.
            \* processed -

            File processing is completed.
            \* processing -

            The file is currently being processed.
            \* queued -

            The file is queued for processing.
            \* cancelled -

            The file upload or processing was canceled.
            \* failed -

            The file failed to process.
            \* imported -

            Data from the file has been imported.
          enum:
          - queued
          - imported
          - processing
          - processed
          - failed
          example: null
        total_records_count:
          type: integer
          format: int64
          deprecated: false
          description: |
            Total number of records in the file.
          example: null
        processed_records_count:
          type: integer
          format: int64
          deprecated: false
          description: |
            Number of records that were successfully processed.
          example: null
        failed_records_count:
          type: integer
          format: int64
          deprecated: false
          description: |
            Number of records that failed validation or import.
          example: null
        file_size_in_bytes:
          type: integer
          format: int64
          deprecated: false
          description: |
            The size of the file in bytes.
          example: null
        processing_started_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the file processing began.
          example: null
        processing_completed_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the file processing was completed.
          example: null
        uploaded_by:
          type: string
          deprecated: false
          description: |
            Identifier of the user or system that uploaded the file.
          maxLength: 100
          example: null
        uploaded_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the file was uploaded.
          example: null
        error_file_path:
          type: string
          deprecated: false
          description: |
            Amazon S3 path in your bucket where the error file containing error codes is uploaded.
          maxLength: 2000
          example: null
        error_file_url:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Pre-signed URL for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">error_file</code>
            containing <code><a href="/docs/api/usage_files/usage_file-object#error_code">error_codes</a></code>.
            The link is valid for 60 minutes.</p>
          maxLength: 2000
          example: null
        upload_details:
          type: object
          deprecated: false
          description: |
            Contains details of the file upload.
          properties:
            url:
              type: string
              deprecated: false
              description: |
                Pre-signed URL where the file is uploaded.
              maxLength: 2000
              example: null
            expires_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Expiry time of the pre-signed upload URL.
              example: null
          required:
          - expires_at
          - url
          example: null
      required:
      - id
      - mime_type
      - name
      example: null
    UsageFileIngestedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            usage_file:
              $ref: "#/components/schemas/UsageFile"
          required:
          - usage_file
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    UsageSummary:
      type: object
      description: |
        Usage summary represents aggregated usage data for a metered [feature](/docs/api/features/feature-object) in a [subscription](/docs/api/subscriptions/subscription-object) over a specific reporting period. The aggregation is performed based on the [aggregation method](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/defining-metered-features) configured in Billing.

        Use this resource to analyze feature-level usage for reporting or analytics purposes, independent of usage billing or invoicing.
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the subscription for which usage is reported.
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the metered feature for which usage is aggregated.
          maxLength: 100
          example: null
        aggregated_value:
          type: string
          deprecated: false
          description: <p class="mb-2">The total usage aggregated over the reporting
            window defined by <code class="bg-gray-100 text-gray-800 font-medium border
            border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">aggregated_from</code>
            and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300
            rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">aggregated_to</code>.
            The aggregation is performed based on the <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/defining-metered-features"
            target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800
            underline">aggregation method</a> configured in Billing.</p>
          maxLength: 33
          example: null
        aggregated_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The start timestamp (inclusive) of the aggregation window in UTC.
          example: null
        aggregated_to:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The end timestamp (exclusive) of the aggregation window in UTC.
          example: null
      required:
      - aggregated_from
      - aggregated_to
      - aggregated_value
      - feature_id
      - subscription_id
      example: null
    ValidationStatus:
      type: string
      default: not_validated
      deprecated: false
      enum:
      - not_validated
      - valid
      - partially_valid
      - invalid
      example: null
    VirtualBankAccount:
      type: object
      description: |
        A virtual bank account is a unique account number which is generated so you don't need to share your sensitive bank account details with your users. A virtual bank account can be paid with ACH credit or wire transfer. Users can make payment of the amount due to this account, and the amount will be matched with the invoice.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Identifier of the virtual bank account
          maxLength: 40
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            Identifier of the customer.
          maxLength: 50
          example: null
        email:
          type: string
          format: email
          deprecated: false
          description: |
            Email address associated with the virtual bank account
          maxLength: 70
          example: null
        scheme:
          type: string
          default: ach_credit
          deprecated: false
          description: |-
            <p class="mb-2">Type of the credit transfer</p>
            * eu_automated_bank_transfer - <p class="mb-2">EU Automated Bank Transfer</p>
            * ach_credit - <p class="mb-2">ACH Credit Transfer</p>
            <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ach_credit</code>
            use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">us_automated_bank_transfer</code>
            .</p></div>
            * gb_automated_bank_transfer - <p class="mb-2">UK Automated Bank Transfer</p>
            * mx_automated_bank_transfer - <p class="mb-2">MX Automated Bank Transfer</p>
            * jp_automated_bank_transfer - <p class="mb-2">JP Automated Bank Transfer</p>
            * us_automated_bank_transfer - <p class="mb-2">US Automated Bank Transfer</p>
            * sepa_credit - <p class="mb-2">SEPA Credit Transfer</p>
            <div class="alert alert-info"><p class="mb-2">This scheme is deprecated. Instead of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sepa_credit</code>
            use <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">eu_automated_bank_transfer</code>
            .</p></div>
          enum:
          - ach_credit
          - sepa_credit
          - us_automated_bank_transfer
          - gb_automated_bank_transfer
          - eu_automated_bank_transfer
          - jp_automated_bank_transfer
          - mx_automated_bank_transfer
          example: null
        bank_name:
          type: string
          deprecated: false
          description: |
            Name of the bank
          maxLength: 100
          example: null
        account_number:
          type: string
          deprecated: false
          description: |
            The account number to which funds will be transferred.
          maxLength: 50
          minLength: 5
          example: null
        routing_number:
          type: string
          deprecated: false
          description: |
            The routing number of the bank
          maxLength: 50
          minLength: 3
          example: null
        swift_code:
          type: string
          deprecated: false
          description: |
            Swift code of the bank in which the account exists.
          maxLength: 11
          minLength: 3
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Name of the gateway this virtual bank account is stored in.\n\
            \\* twikey -\n\nTwikey is a payment service provider that specializes\
            \ in processing direct debit payments across the EU.\n\\* ecentric -\n\
            \nEcentric provides a seamless payment processing service in South Africa\
            \ specializing on omnichannel capabilities.\n\\* bluesnap -\n\nBlueSnap\
            \ is a payment gateway.\n\\* jp_morgan -\n\nJ.P. Morgan Mobility Payment\
            \ Solutions is a payment gateway that enables you to securely accept and\
            \ manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type).\
            \  \nThis feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature)\
            \ to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL\
            \ for your test and live sites.\n\\* tco -\n\n2Checkout is a payment gateway.\n\
            \\* first_data_global -\n\nFirst Data Global Gateway Virtual Terminal\
            \ Account\n\\* exact -\n\nExact Payments is a payment gateway.\n\\* deutsche_bank\
            \ -\n\nDeutsche Bank is the leading German bank with strong European roots\
            \ and a global network.  \nThis feature is a **Private Beta Release**.\n\
            \\* bluepay -\n\nBluePay is a payment gateway.\n\\* paypal_express_checkout\
            \ -\n\nPayPal Express Checkout is a payment gateway.\n\\* nuvei -\n\n\
            Nuvei is a secure and reliable payment processing solution that allows\
            \ you to accept payments from customers and suitable for various types\
            \ of businesses.  \nThis feature is a **Private Beta Release** . [Request\
            \ access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature)\
            \ to enable Nuvei for your test and live sites.\n\\* eway -\n\neWAY Account\
            \ is a payment gateway.\n\\* metrics_global -\n\nMetrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            \\* paypal_payflow_pro -\n\nPayPal Payflow Pro is a payment gateway.\n\
            \\* razorpay -\n\nRazorpay is a fast growing payment service provider\
            \ in India working with all leading banks and support for major local\
            \ payment methods including Netbanking, UPI etc.\n\\* global_payments\
            \ -\n\nGlobal Payments is a payment service provider.\n\\* amazon_payments\
            \ -\n\nAmazon Payments is a payment service provider.\n\\* dlocal -\n\n\
            Dlocal provides payment solutions for global commerce by accepting local\
            \ payment methods.\n\\* not_applicable -\n\nIndicates that payment gateway\
            \ is not applicable for this resource.\n\\* windcave -\n\nWindcave provides\
            \ an end to end payment processing solution in ANZ and other leading global\
            \ markets.\n\\* checkout_com -\n\nCheckout.com is a payment gateway.\n\
            \\* adyen -\n\nAdyen is a payment gateway.\n\\* braintree -\n\nBraintree\
            \ is a payment gateway.\n\\* nmi -\n\nNMI is a payment gateway.\n\\* quickbooks\
            \ -\n\nIntuit QuickBooks Payments gateway\n\\* wepay -\n\nWePay is a payment\
            \ gateway.\n\\* worldpay -\n\nWorldPay is a payment gateway\n\\* paystack\
            \ -\n\nPaystack is a payment gateway for businesses in Africa. It enables\
            \ secure payment acceptance both online and offline.  \nThis feature is\
            \ a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature)\
            \ to enable Paystack for your test and live sites.\n\\* ezidebit -\n\n\
            Ezidebit is a payment gateway integration based in Australia that supports\
            \ automated direct debit, BPAY, and card payments for businesses.  \n\
            This feature is a **Private Beta Release**.\n\\* pay_com -\n\nPay.com\
            \ provides payment services focused on simplicity and hassle-free operations\
            \ for businesses of all sizes.\n\\* wirecard -\n\nWireCard Account is\
            \ a payment service provider.\n\\* chargebee_payments -\n\nChargebee Payments\
            \ gateway\n\\* sage_pay -\n\nSage Pay is a payment gateway.\n\\* moneris_us\
            \ -\n\nMoneris USA is a payment gateway.\n\\* pin -\n\nPin is a payment\
            \ gateway\n\\* authorize_net -\n\nAuthorize.net is a payment gateway\n\
            \\* elavon -\n\nElavon Virtual Merchant is a payment solution.\n\\* paypal_pro\
            \ -\n\nPayPal Pro Account is a payment gateway.\n\\* orbital -\n\nChase\
            \ Paymentech(Orbital) is a payment gateway.\n\\* paypal -\n\nPayPal Commerce\
            \ is a payment gateway.\n\\* beanstream -\n\nBambora(formerly known as\
            \ Beanstream) is a payment gateway.\n\\* hdfc -\n\nHDFC Account is a payment\
            \ gateway.\n\\* ingenico_direct -\n\nWorldline Online Payments is a payment\
            \ gateway.\n\\* ogone -\n\nIngenico ePayments (formerly known as Ogone)\
            \ is a payment gateway.\n\\* migs -\n\nMasterCard Internet Gateway Service\
            \ payment gateway.\n\\* stripe -\n\nStripe is a payment gateway.\n\\*\
            \ vantiv -\n\nVantiv is a payment gateway.\n\\* moneris -\n\nMoneris is\
            \ a payment gateway.\n\\* bank_of_america -\n\nBank of America Gateway\n\
            \\* chargebee -\n\nChargebee test gateway.\n\\* eway_rapid -\n\neWAY Rapid\
            \ is a payment gateway.\n\\* gocardless -\n\nGoCardless is a payment service\
            \ provider.\n\\* mollie -\n\nMollie is a payment gateway.\n\\* paymill\
            \ -\n\nPAYMILL is a payment gateway.\n\\* balanced_payments -\n\nBalanced\
            \ is a payment gateway\n\\* solidgate -\n\nSolidgate is a secure and reliable\
            \ payment processing solution that allows you to accept payments from\
            \ customers and suitable for various types of businesses.  \nThis feature\
            \ is a **Private Beta Release**.\n\\* cybersource -\n\nCyberSource is\
            \ a payment gateway.\n\\* ebanx -\n\nEBANX is a payment gateway, enabling\
            \ businesses to accept diverse local payment methods from various countries\
            \ for increased market reach and conversion.\n"
          enum:
          - chargebee
          - chargebee_payments
          - adyen
          - stripe
          - wepay
          - braintree
          - authorize_net
          - paypal_pro
          - pin
          - eway
          - eway_rapid
          - worldpay
          - balanced_payments
          - beanstream
          - bluepay
          - elavon
          - first_data_global
          - hdfc
          - migs
          - nmi
          - ogone
          - paymill
          - paypal_payflow_pro
          - sage_pay
          - tco
          - wirecard
          - amazon_payments
          - paypal_express_checkout
          - gocardless
          - orbital
          - moneris_us
          - moneris
          - bluesnap
          - cybersource
          - vantiv
          - checkout_com
          - paypal
          - ingenico_direct
          - exact
          - mollie
          - quickbooks
          - razorpay
          - global_payments
          - bank_of_america
          - ecentric
          - metrics_global
          - windcave
          - pay_com
          - ebanx
          - dlocal
          - nuvei
          - solidgate
          - paystack
          - jp_morgan
          - deutsche_bank
          - ezidebit
          - twikey
          - tempus
          - moyasar
          - payway
          - not_applicable
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          description: |
            The gateway account in which this virtual bank account is stored.
          maxLength: 50
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |-
            <p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code>
            is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this virtual bank account resource was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this virtual bank account resource is created.
          example: null
        reference_id:
          type: string
          deprecated: false
          description: |
            Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).
          maxLength: 150
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
      required:
      - account_number
      - created_at
      - customer_id
      - deleted
      - email
      - gateway
      - gateway_account_id
      - id
      - reference_id
      example: null
    VirtualBankAccountAddedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            virtual_bank_account:
              $ref: "#/components/schemas/VirtualBankAccount"
          required:
          - customer
          - virtual_bank_account
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VirtualBankAccountDeletedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            virtual_bank_account:
              $ref: "#/components/schemas/VirtualBankAccount"
          required:
          - customer
          - virtual_bank_account
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VirtualBankAccountUpdatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            customer:
              $ref: "#/components/schemas/Customer"
            virtual_bank_account:
              $ref: "#/components/schemas/VirtualBankAccount"
          required:
          - customer
          - virtual_bank_account
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VoucherCreateFailedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            payment_voucher:
              $ref: "#/components/schemas/PaymentVoucher"
          required:
          - payment_voucher
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VoucherCreatedEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            payment_voucher:
              $ref: "#/components/schemas/PaymentVoucher"
          required:
          - payment_voucher
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VoucherExpiredEvent:
      type: object
      properties:
        id:
          type: string
          description: |
            The ID of the event
          example: null
        occurred_at:
          type: integer
          format: int64
          description: |
            Timestamp of the event
          example: null
        source:
          type: string
          description: |
            Source of the event
          example: null
        object:
          type: string
          description: |
            The object of the event
          example: null
        api_version:
          type: string
          description: |
            API version
          example: null
        event_type:
          type: string
          description: |
            Type of the event
          example: null
        webhook_status:
          type: string
          description: |
            Status of webhook
          example: null
        content:
          type: object
          properties:
            payment_voucher:
              $ref: "#/components/schemas/PaymentVoucher"
          required:
          - payment_voucher
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VoucherType:
      type: string
      deprecated: false
      enum:
      - boleto
      example: null
    WebhookEndpoint:
      type: object
      description: "A webhook endpoint receives real-time notifications from your\
        \ Chargebee site when specific events occur, such as invoice generation, payment\
        \ failures, or subscription updates. It allows your application, server, or\
        \ third-party service to automatically respond to these changes, eliminating\
        \ the need for manual checks or polling the API.\nEach webhook endpoint includes\
        \ details such as a unique ID, target URL, list of subscribed events, and\
        \ status. You can manage webhook endpoints using the Chargebee dashboard or\
        \ the API.  \n**Note**\nYou can create up to five webhook endpoints per site.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the webhook.
          maxLength: 40
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The name assigned to the webhook.
          maxLength: 50
          example: null
        url:
          type: string
          deprecated: false
          description: |
            The full URL of the webhook endpoint.
          maxLength: 512
          example: null
        send_card_resource:
          type: boolean
          default: false
          deprecated: false
          description: |
            Controls whether card-related resources are included in the webhook payload. Card details are always masked.
          example: null
        disabled:
          type: boolean
          default: false
          deprecated: false
          description: |-
            <p class="mb-2">Indicates whether the webhook endpoint is disabled. If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>
            , the endpoint is disabled; if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>
            , it is enabled.</p>
          example: null
        primary_url:
          type: boolean
          default: false
          deprecated: false
          description: |
            Indicates whether this is the primary webhook endpoint. If only one endpoint exists, it is considered primary by default.
          example: null
        api_version:
          type: string
          default: v2
          deprecated: false
          description: |
            Specifies the API version used to format the webhook payload. Make sure this version matches the client library version used by your webhook server.
            \* v1 -

            If selected, the webhook payload includes only attributes from API v1 resources.
            \* v2 -

            If selected, the webhook payload includes only attributes from API v2 resources.
          enum:
          - v1
          - v2
          example: null
        chargebee_response_schema_type:
          type: string
          deprecated: false
          description: |-
            <p class="mb-2">Indicates the response schema used in the webhook payload,  based on the product catalog version configured for the site.</p>
            <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>
            This field is only applicable if the site is in <a href="https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog-coexistence-ui-changes"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">compat</code></a> mode.</p></div>
            * compat - <p class="mb-2">The webhook payload uses a schema compatible with both Product Catalog 1.0 and 2.0. This is applicable only to sites automatically upgraded to Product Catalog 2.0.</p>
            * items - <p class="mb-2">The webhook payload follows the <a href="https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Product Catalog 2.0</a>
            schema and uses the <a href="/docs/api/items">Items API model</a>
            .</p>
            * plans_addons - <p class="mb-2">The webhook payload follows the <a href="https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog">Product Catalog 1.0</a>
            schema and uses the <a href="/docs/api/v2/pcv-1/plans">Plans</a>
            and <a href="/docs/api/v2/pcv-1/addons">Addons</a>
            model.</p>
          enum:
          - plans_addons
          - items
          - compat
          example: null
        enabled_events:
          type: array
          deprecated: false
          description: |
            The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/v2/pcv-1/webhook_endpoints)
            .
          items:
            type: string
            deprecated: false
            description: |
              The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/v2/pcv-1/webhook_endpoints)
              .
            enum:
            - plan_created
            - plan_updated
            - plan_deleted
            - addon_created
            - addon_updated
            - addon_deleted
            - coupon_created
            - coupon_updated
            - coupon_deleted
            - coupon_set_created
            - coupon_set_updated
            - coupon_set_deleted
            - coupon_codes_added
            - coupon_codes_deleted
            - coupon_codes_updated
            - customer_created
            - customer_changed
            - customer_deleted
            - customer_moved_out
            - customer_moved_in
            - promotional_credits_added
            - promotional_credits_deducted
            - subscription_created
            - subscription_created_with_backdating
            - subscription_started
            - subscription_trial_end_reminder
            - subscription_activated
            - subscription_activated_with_backdating
            - subscription_changed
            - subscription_trial_extended
            - mrr_updated
            - subscription_changed_with_backdating
            - subscription_cancellation_scheduled
            - subscription_cancellation_reminder
            - subscription_cancelled
            - subscription_canceled_with_backdating
            - subscription_reactivated
            - subscription_reactivated_with_backdating
            - subscription_renewed
            - subscription_items_renewed
            - subscription_scheduled_cancellation_removed
            - subscription_changes_scheduled
            - subscription_scheduled_changes_removed
            - subscription_shipping_address_updated
            - subscription_deleted
            - subscription_paused
            - subscription_pause_scheduled
            - subscription_scheduled_pause_removed
            - subscription_resumed
            - subscription_resumption_scheduled
            - subscription_scheduled_resumption_removed
            - subscription_advance_invoice_schedule_added
            - subscription_advance_invoice_schedule_updated
            - subscription_advance_invoice_schedule_removed
            - pending_invoice_created
            - pending_invoice_updated
            - invoice_generated
            - invoice_generated_with_backdating
            - invoice_updated
            - invoice_deleted
            - credit_note_created
            - credit_note_created_with_backdating
            - credit_note_updated
            - credit_note_deleted
            - subscription_renewal_reminder
            - transaction_created
            - transaction_updated
            - transaction_deleted
            - payment_succeeded
            - payment_failed
            - dunning_updated
            - payment_refunded
            - payment_initiated
            - refund_initiated
            - authorization_succeeded
            - authorization_voided
            - card_added
            - card_updated
            - card_expiry_reminder
            - card_expired
            - card_deleted
            - payment_source_added
            - payment_source_updated
            - payment_source_deleted
            - payment_source_expiring
            - payment_source_expired
            - payment_source_locally_deleted
            - virtual_bank_account_added
            - virtual_bank_account_updated
            - virtual_bank_account_deleted
            - token_created
            - token_consumed
            - token_expired
            - unbilled_charges_created
            - unbilled_charges_voided
            - unbilled_charges_deleted
            - unbilled_charges_invoiced
            - order_created
            - order_updated
            - order_cancelled
            - order_delivered
            - order_returned
            - order_ready_to_process
            - order_ready_to_ship
            - order_deleted
            - order_resent
            - quote_created
            - quote_updated
            - quote_deleted
            - tax_withheld_recorded
            - tax_withheld_deleted
            - tax_withheld_refunded
            - gift_scheduled
            - gift_unclaimed
            - gift_claimed
            - gift_expired
            - gift_cancelled
            - gift_updated
            - hierarchy_created
            - hierarchy_deleted
            - payment_intent_created
            - payment_intent_updated
            - contract_term_created
            - contract_term_renewed
            - contract_term_terminated
            - contract_term_completed
            - contract_term_cancelled
            - voucher_created
            - voucher_expired
            - voucher_create_failed
            - subscription_ramp_created
            - subscription_ramp_deleted
            - subscription_ramp_applied
            - subscription_ramp_drafted
            - subscription_ramp_updated
            - subscription_moved_in
            - subscription_moved_out
            - subscription_movement_failed
            - omnichannel_subscription_created
            - omnichannel_subscription_item_renewed
            - omnichannel_subscription_item_downgraded
            - omnichannel_subscription_item_expired
            - omnichannel_subscription_item_cancellation_scheduled
            - omnichannel_subscription_item_scheduled_cancellation_removed
            - omnichannel_subscription_item_resubscribed
            - omnichannel_subscription_item_upgraded
            - omnichannel_subscription_item_cancelled
            - omnichannel_subscription_imported
            - omnichannel_subscription_item_grace_period_started
            - omnichannel_subscription_item_grace_period_expired
            - omnichannel_subscription_item_dunning_started
            - omnichannel_subscription_item_dunning_expired
            - rule_created
            - rule_updated
            - rule_deleted
            - record_purchase_failed
            - omnichannel_subscription_item_change_scheduled
            - omnichannel_subscription_item_scheduled_change_removed
            - omnichannel_subscription_item_reactivated
            - sales_order_created
            - sales_order_updated
            - omnichannel_subscription_item_changed
            - omnichannel_subscription_item_paused
            - omnichannel_subscription_item_resumed
            - omnichannel_one_time_order_created
            - omnichannel_one_time_order_item_cancelled
            - usage_file_ingested
            - omnichannel_subscription_item_pause_scheduled
            example: null
          example: null
      required:
      - api_version
      - disabled
      - id
      - name
      - primary_url
      - url
      example: null
  parameters:
    payment-voucher-id:
      name: payment-voucher-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    item-price-id:
      name: item-price-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    reason-code-id:
      name: reason-code-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    differential-price-id:
      name: differential-price-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    tax-withheld-id:
      name: tax-withheld-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    sales-order-id:
      name: sales-order-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    in-app-subscription-app-id:
      name: in-app-subscription-app-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    quote-id:
      name: quote-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
        example: null
    include_deleted:
      name: include_deleted
      in: query
      required: false
      style: form
      explode: true
      schema:
        type: boolean
        default: false
        description: Indicates whether to include deleted objects in the list. The
          deleted objects have the attribute `deleted` as `true`.
    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})))?::)))))$"
    coupon-code-code:
      name: coupon-code-code
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    pc2-migration-item-family-id:
      name: pc2-migration-item-family-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
        example: null
    entitlement-override-id:
      name: entitlement-override-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    subscription-id:
      name: subscription-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    hosted-page-id:
      name: hosted-page-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    credit-note-id:
      name: credit-note-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    virtual-bank-account-id:
      name: virtual-bank-account-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    chargebee-event-webhook:
      name: chargebee-event-webhook
      in: header
      description: ' skip only webhooks'
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: ' skip only webhooks'
        enum:
        - all-disabled
    e-invoicing-country-country:
      name: e-invoicing-country-country
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    coupon-set-id:
      name: coupon-set-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    non-subscription-app-id:
      name: non-subscription-app-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    portal-session-id:
      name: portal-session-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    attached-item-id:
      name: attached-item-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    plan-id:
      name: plan-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
    meter-id:
      name: meter-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    business-entity-id:
      name: business-entity-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    item-id:
      name: item-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    subscription-entitlement-id:
      name: subscription-entitlement-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    customer-id:
      name: customer-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    cust-payment-source-id:
      name: cust-payment-source-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    site-currency-id:
      name: site-currency-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
    thunking-plan-id:
      name: thunking-plan-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    tp-site-user-domain:
      name: tp-site-user-domain
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    event-id:
      name: event-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    async-response-id:
      name: async-response-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    site-owner-id:
      name: site-owner-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    rule-id:
      name: rule-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    time-machine-name:
      name: time-machine-name
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    item-family-id:
      name: item-family-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    product-id:
      name: product-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    invoice-id:
      name: invoice-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    feature-id:
      name: feature-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    transaction-id:
      name: transaction-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    offer-fulfillment-id:
      name: offer-fulfillment-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    cb-token-id:
      name: cb-token-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    chargebee-event-email:
      name: chargebee-event-email
      in: header
      description: skip only emails
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: skip only emails
        enum:
        - all-disabled
    comment-id:
      name: comment-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    webhook-endpoint-id:
      name: webhook-endpoint-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    pc2-migration-item-id:
      name: pc2-migration-item-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    usage-file-id:
      name: usage-file-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    coupon-id:
      name: coupon-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    alert-id:
      name: alert-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    payment-intent-id:
      name: payment-intent-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    tp-integ-sync-detail-id:
      name: tp-integ-sync-detail-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    order-id:
      name: order-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    pc2-migration-item-price-id:
      name: pc2-migration-item-price-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    product-variant-id:
      name: product-variant-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    account-credit-id:
      name: account-credit-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    chargebee-event-actions:
      name: chargebee-event-actions
      in: header
      description: skip all actions to be done on the events
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: skip all actions to be done on the events
        enum:
        - all-disabled
    pc2-migration-id:
      name: pc2-migration-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    async-api-request-id:
      name: async-api-request-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
    custom-pricing-unit-id:
      name: custom-pricing-unit-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    export-id:
      name: export-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    gift-id:
      name: gift-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    unbilled-charge-id:
      name: unbilled-charge-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    addon-id:
      name: addon-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
jsonSchemaDialect: https://spec.openapis.org/oas/3.1/dialect/base
webhooks:
  subscription_pause_scheduled:
    description: <p class="mb-2">Triggered when the subscription is scheduled to pause.</p>
    post:
      summary: Triggered when the subscription is scheduled to pause.
      description: <p class="mb-2">Triggered when the subscription is scheduled to
        pause.</p>
      operationId: onSubscription_pause_scheduledWebhook
      requestBody:
        description: Payload for subscription_pause_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionPauseScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  netd_payment_due_reminder:
    post:
      summary: Sent when a invoice's due period is about to end
      operationId: onNetd_payment_due_reminderWebhook
      requestBody:
        description: Payload for netd_payment_due_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NetdPaymentDueReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  order_delivered:
    description: <p class="mb-2">Triggered when an order is delivered.</p>
    post:
      summary: Triggered when an order is delivered.
      description: <p class="mb-2">Triggered when an order is delivered.</p>
      operationId: onOrder_deliveredWebhook
      requestBody:
        description: Payload for order_delivered event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderDeliveredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_advance_invoice_schedule_added:
    description: <p class="mb-2">Triggered when advance invoice is scheduled for a
      subscription.</p>
    post:
      summary: Triggered when advance invoice is scheduled for a subscription.
      description: <p class="mb-2">Triggered when advance invoice is scheduled for
        a subscription.</p>
      operationId: onSubscription_advance_invoice_schedule_addedWebhook
      requestBody:
        description: Payload for subscription_advance_invoice_schedule_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionAdvanceInvoiceScheduleAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_expired:
    description: <p class="mb-2">Triggered when a gift expires.</p>
    post:
      summary: Triggered when a gift expires.
      description: <p class="mb-2">Triggered when a gift expires.</p>
      operationId: onGift_expiredWebhook
      requestBody:
        description: Payload for gift_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  tax_withheld_deleted:
    description: <p class="mb-2">Triggered when a tax withheld is deleted.</p>
    post:
      summary: Triggered when a tax withheld is deleted.
      description: <p class="mb-2">Triggered when a tax withheld is deleted.</p>
      operationId: onTax_withheld_deletedWebhook
      requestBody:
        description: Payload for tax_withheld_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TaxWithheldDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_added:
    description: <p class="mb-2">Triggered when coupon codes are added in coupon set.</p>
    post:
      summary: Triggered when coupon codes are added in coupon set.
      description: <p class="mb-2">Triggered when coupon codes are added in coupon
        set.</p>
      operationId: onCoupon_codes_addedWebhook
      requestBody:
        description: Payload for coupon_codes_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponCodesAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  unbilled_charges_deleted:
    description: <p class="mb-2">Triggered when unbilled charges are deleted</p>
    post:
      summary: Triggered when unbilled charges are deleted
      description: <p class="mb-2">Triggered when unbilled charges are deleted</p>
      operationId: onUnbilled_charges_deletedWebhook
      requestBody:
        description: Payload for unbilled_charges_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UnbilledChargesDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_cancelled:
    description: <p class="mb-2">Triggered when gift is cancelled.</p>
    post:
      summary: Triggered when gift is cancelled.
      description: <p class="mb-2">Triggered when gift is cancelled.</p>
      operationId: onGift_cancelledWebhook
      requestBody:
        description: Payload for gift_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_updated:
    description: <p class="mb-2">Triggered when a coupon is changed.</p>
    post:
      summary: Triggered when a coupon is changed.
      description: <p class="mb-2">Triggered when a coupon is changed.</p>
      operationId: onCoupon_updatedWebhook
      requestBody:
        description: Payload for coupon_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_cancelled:
    description: <p class="mb-2">Triggered when an order is cancelled.</p>
    post:
      summary: Triggered when an order is cancelled.
      description: <p class="mb-2">Triggered when an order is cancelled.</p>
      operationId: onOrder_cancelledWebhook
      requestBody:
        description: Payload for order_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_deleted:
    description: <p class="mb-2">Triggered when a coupon is deleted.</p>
    post:
      summary: Triggered when a coupon is deleted.
      description: <p class="mb-2">Triggered when a coupon is deleted.</p>
      operationId: onCoupon_deletedWebhook
      requestBody:
        description: Payload for coupon_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_changes_removed:
    description: <p class="mb-2">Triggered when scheduled change for the subscription
      is removed.</p>
    post:
      summary: Triggered when scheduled change for the subscription is removed.
      description: <p class="mb-2">Triggered when scheduled change for the subscription
        is removed.</p>
      operationId: onSubscription_scheduled_changes_removedWebhook
      requestBody:
        description: Payload for subscription_scheduled_changes_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionScheduledChangesRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  pending_invoice_created:
    description: "<p class=\"mb-2\">Event triggered (in the case of metered billing)\
      \ when a &quot;Pending&quot; invoice is created that has usage related charges\
      \ or line items to be added, before being closed. This is triggered only when\
      \ the &quot;Notify for Pending Invoices&quot; option is enabled.</p>"
    post:
      summary: "Event triggered (in the case of metered billing) when a \"Pending\"\
        \ invoice is created that has usage related charges or line items to be added,\
        \ before being closed. This is triggered only when the “Notify for Pending\
        \ Invoices” option is enabled."
      description: "<p class=\"mb-2\">Event triggered (in the case of metered billing)\
        \ when a &quot;Pending&quot; invoice is created that has usage related charges\
        \ or line items to be added, before being closed. This is triggered only when\
        \ the &quot;Notify for Pending Invoices&quot; option is enabled.</p>"
      operationId: onPending_invoice_createdWebhook
      requestBody:
        description: Payload for pending_invoice_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PendingInvoiceCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  unbilled_charges_created:
    description: <p class="mb-2">Triggered when unbilled charges are created</p>
    post:
      summary: Triggered when unbilled charges are created
      description: <p class="mb-2">Triggered when unbilled charges are created</p>
      operationId: onUnbilled_charges_createdWebhook
      requestBody:
        description: Payload for unbilled_charges_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UnbilledChargesCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_resumed:
    description: <p class="mb-2">Triggered when the subscription is resumed.</p>
    post:
      summary: Triggered when the subscription is resumed.
      description: <p class="mb-2">Triggered when the subscription is resumed.</p>
      operationId: onSubscription_resumedWebhook
      requestBody:
        description: Payload for subscription_resumed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionResumedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_cancelled:
    description: "<p class=\"mb-2\">Triggered when the subscription is cancelled.\
      \ If it is cancelled due to non payment or because the card details are not\
      \ present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;.</p>"
    post:
      summary: "Triggered when the subscription is cancelled. If it is cancelled due\
        \ to non payment or because the card details are not present, the subscription\
        \ will have the possible reason as 'cancel_reason'."
      description: "<p class=\"mb-2\">Triggered when the subscription is cancelled.\
        \ If it is cancelled due to non payment or because the card details are not\
        \ present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;.</p>"
      operationId: onSubscription_cancelledWebhook
      requestBody:
        description: Payload for subscription_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_deleted:
    description: <p class="mb-2">Triggered when a payment source is deleted.</p>
    post:
      summary: Triggered when a payment source is deleted.
      description: <p class="mb-2">Triggered when a payment source is deleted.</p>
      operationId: onPayment_source_deletedWebhook
      requestBody:
        description: Payload for payment_source_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  quote_deleted:
    description: <p class="mb-2">Event triggered when a new quote is deleted.</p>
    post:
      summary: Event triggered when a new quote is deleted.
      description: <p class="mb-2">Event triggered when a new quote is deleted.</p>
      operationId: onQuote_deletedWebhook
      requestBody:
        description: Payload for quote_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QuoteDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  invoice_updated:
    description: "<p class=\"mb-2\">Triggered when you make the following changes\
      \ to a pending invoice - add a charge, add a non-recurring addon, or delete\
      \ a line item.</p>"
    post:
      summary: "Triggered when you make the following changes to a pending invoice\
        \ - add a charge, add a non-recurring addon, or delete a line item."
      description: "<p class=\"mb-2\">Triggered when you make the following changes\
        \ to a pending invoice - add a charge, add a non-recurring addon, or delete\
        \ a line item.</p>"
      operationId: onInvoice_updatedWebhook
      requestBody:
        description: Payload for invoice_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InvoiceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_set_updated:
    description: <p class="mb-2">Triggered when a coupon set is updated.</p>
    post:
      summary: Triggered when a coupon set is updated.
      description: <p class="mb-2">Triggered when a coupon set is updated.</p>
      operationId: onCoupon_set_updatedWebhook
      requestBody:
        description: Payload for coupon_set_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponSetUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_advance_invoice_schedule_removed:
    description: <p class="mb-2">Triggered when scheduled advance invoice is removed
      for a subscription.</p>
    post:
      summary: Triggered when scheduled advance invoice is removed for a subscription.
      description: <p class="mb-2">Triggered when scheduled advance invoice is removed
        for a subscription.</p>
      operationId: onSubscription_advance_invoice_schedule_removedWebhook
      requestBody:
        description: Payload for subscription_advance_invoice_schedule_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionAdvanceInvoiceScheduleRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_activated_with_backdating:
    description: "<p class=\"mb-2\">Triggered after the subscription changes to <code\
      \ class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded\
      \ px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code> from\
      \ another <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">status</code>,\
      \ while the change is backdated.</p>"
    post:
      summary: "Triggered after the subscription changes to `active` from another\
        \ `status`, while the change is backdated."
      description: "<p class=\"mb-2\">Triggered after the subscription changes to\
        \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code>\
        \ from another <code class=\"bg-gray-100 text-gray-800 font-medium border\
        \ border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\"\
        >status</code>, while the change is backdated.</p>"
      operationId: onSubscription_activated_with_backdatingWebhook
      requestBody:
        description: Payload for subscription_activated_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionActivatedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_deleted:
    description: <p class="mb-2">Triggered when a card is deleted for a customer.</p>
    post:
      summary: Triggered when a card is deleted for a customer.
      description: <p class="mb-2">Triggered when a card is deleted for a customer.</p>
      operationId: onCard_deletedWebhook
      requestBody:
        description: Payload for card_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CardDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_ready_to_ship:
    description: <p class="mb-2">Triggered when an order reaches it&#x27;s shipping
      date.</p>
    post:
      summary: Triggered when an order reaches it's shipping date.
      description: <p class="mb-2">Triggered when an order reaches it&#x27;s shipping
        date.</p>
      operationId: onOrder_ready_to_shipWebhook
      requestBody:
        description: Payload for order_ready_to_ship event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReadyToShipEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_trial_end_reminder:
    description: <p class="mb-2">Triggered 6 days prior to the trial period&#x27;s
      end date.</p>
    post:
      summary: Triggered 6 days prior to the trial period's end date.
      description: <p class="mb-2">Triggered 6 days prior to the trial period&#x27;s
        end date.</p>
      operationId: onSubscription_trial_end_reminderWebhook
      requestBody:
        description: Payload for subscription_trial_end_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionTrialEndReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_shipping_address_updated:
    description: <p class="mb-2">Triggered when shipping address is added or updated
      for a subscription.</p>
    post:
      summary: Triggered when shipping address is added or updated for a subscription.
      description: <p class="mb-2">Triggered when shipping address is added or updated
        for a subscription.</p>
      operationId: onSubscription_shipping_address_updatedWebhook
      requestBody:
        description: Payload for subscription_shipping_address_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionShippingAddressUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_moved_out:
    post:
      summary: Triggered when a subscription moved to other customer
      operationId: onSubscription_moved_outWebhook
      requestBody:
        description: Payload for subscription_moved_out event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionMovedOutEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  voucher_create_failed:
    description: <p class="mb-2">Triggered when the Payment voucher Creation fails.</p>
    post:
      summary: Triggered when the Payment voucher Creation fails.
      description: <p class="mb-2">Triggered when the Payment voucher Creation fails.</p>
      operationId: onVoucher_create_failedWebhook
      requestBody:
        description: Payload for voucher_create_failed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VoucherCreateFailedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_claimed:
    description: <p class="mb-2">Triggered when a gift is claimed.</p>
    post:
      summary: Triggered when a gift is claimed.
      description: <p class="mb-2">Triggered when a gift is claimed.</p>
      operationId: onGift_claimedWebhook
      requestBody:
        description: Payload for gift_claimed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftClaimedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_resumption_removed:
    description: <p class="mb-2">Triggered when scheduled resumption is removed for
      the subscription.</p>
    post:
      summary: Triggered when scheduled resumption is removed for the subscription.
      description: <p class="mb-2">Triggered when scheduled resumption is removed
        for the subscription.</p>
      operationId: onSubscription_scheduled_resumption_removedWebhook
      requestBody:
        description: Payload for subscription_scheduled_resumption_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionScheduledResumptionRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_initiated:
    description: <p class="mb-2">Triggered when a payment is initiated via direct
      debit.</p>
    post:
      summary: Triggered when a payment is initiated via direct debit.
      description: <p class="mb-2">Triggered when a payment is initiated via direct
        debit.</p>
      operationId: onPayment_initiatedWebhook
      requestBody:
        description: Payload for payment_initiated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentInitiatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_reactivated_with_backdating:
    description: "<p class=\"mb-2\">Triggered when the subscription is moved from\
      \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">cancelled</code>\
      \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">status</code>\
      \ to <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code>\
      \ or <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">in_trial</code>,\
      \ while <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
      \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">reactivate_from</code>\
      \ is set to a value in the past.</p>"
    post:
      summary: "Triggered when the subscription is moved from `cancelled` `status`\
        \ to `active` or `in_trial`, while `reactivate_from` is set to a value in\
        \ the past."
      description: "<p class=\"mb-2\">Triggered when the subscription is moved from\
        \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">cancelled</code>\
        \ <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">status</code>\
        \ to <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">active</code>\
        \ or <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">in_trial</code>,\
        \ while <code class=\"bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\">reactivate_from</code>\
        \ is set to a value in the past.</p>"
      operationId: onSubscription_reactivated_with_backdatingWebhook
      requestBody:
        description: Payload for subscription_reactivated_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionReactivatedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_deleted:
    description: <p class="mb-2">Triggered when a customer is deleted.</p>
    post:
      summary: Triggered when a customer is deleted.
      description: <p class="mb-2">Triggered when a customer is deleted.</p>
      operationId: onCustomer_deletedWebhook
      requestBody:
        description: Payload for customer_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  token_expired:
    description: <p class="mb-2">Triggered when a nonce is expired.</p>
    post:
      summary: Triggered when a nonce is expired.
      description: <p class="mb-2">Triggered when a nonce is expired.</p>
      operationId: onToken_expiredWebhook
      requestBody:
        description: Payload for token_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TokenExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_added:
    description: <p class="mb-2">Triggered when a card is added for a customer.</p>
    post:
      summary: Triggered when a card is added for a customer.
      description: <p class="mb-2">Triggered when a card is added for a customer.</p>
      operationId: onCard_addedWebhook
      requestBody:
        description: Payload for card_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CardAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_created:
    description: <p class="mb-2">Triggered when a coupon is created.</p>
    post:
      summary: Triggered when a coupon is created.
      description: <p class="mb-2">Triggered when a coupon is created.</p>
      operationId: onCoupon_createdWebhook
      requestBody:
        description: Payload for coupon_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  refund_initiated:
    description: <p class="mb-2">Triggered when a refund is initiated via direct debit.</p>
    post:
      summary: Triggered when a refund is initiated via direct debit.
      description: <p class="mb-2">Triggered when a refund is initiated via direct
        debit.</p>
      operationId: onRefund_initiatedWebhook
      requestBody:
        description: Payload for refund_initiated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RefundInitiatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  invoice_generated_with_backdating:
    description: "<p class=\"mb-2\">Triggered when an invoice has been created with\
      \ date set to a value in the past. However, if the invoice is created with a\
      \ pending status and the site setting is to set invoice.date to the date of\
      \ closing the invoice, this event is never triggered.</p>"
    post:
      summary: "Triggered when an invoice has been created with date set to a value\
        \ in the past. However, if the invoice is created with a pending status and\
        \ the site setting is to set invoice.date to the date of closing the invoice,\
        \ this event is never triggered."
      description: "<p class=\"mb-2\">Triggered when an invoice has been created with\
        \ date set to a value in the past. However, if the invoice is created with\
        \ a pending status and the site setting is to set invoice.date to the date\
        \ of closing the invoice, this event is never triggered.</p>"
      operationId: onInvoice_generated_with_backdatingWebhook
      requestBody:
        description: Payload for invoice_generated_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InvoiceGeneratedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  rule_deleted:
    post:
      summary: Triggered when a rule is deleted
      operationId: onRule_deletedWebhook
      requestBody:
        description: Payload for rule_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RuleDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  virtual_bank_account_deleted:
    description: <p class="mb-2">Triggered when a virtual bank account is deleted.</p>
    post:
      summary: Triggered when a virtual bank account is deleted.
      description: <p class="mb-2">Triggered when a virtual bank account is deleted.</p>
      operationId: onVirtual_bank_account_deletedWebhook
      requestBody:
        description: Payload for virtual_bank_account_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VirtualBankAccountDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_created:
    description: <p class="mb-2">Triggered when a new subscription is created.</p>
    post:
      summary: Triggered when a new subscription is created.
      description: <p class="mb-2">Triggered when a new subscription is created.</p>
      operationId: onSubscription_createdWebhook
      requestBody:
        description: Payload for subscription_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  voucher_created:
    description: <p class="mb-2">Triggered when a Payment voucher is created.</p>
    post:
      summary: Triggered when a Payment voucher is created.
      description: <p class="mb-2">Triggered when a Payment voucher is created.</p>
      operationId: onVoucher_createdWebhook
      requestBody:
        description: Payload for voucher_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VoucherCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  rule_updated:
    post:
      summary: Triggered when a rule is updated
      operationId: onRule_updatedWebhook
      requestBody:
        description: Payload for rule_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RuleUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_locally_deleted:
    description: <p class="mb-2">Triggered when a payment source is deleted at Chargebee.</p>
    post:
      summary: Triggered when a payment source is deleted at Chargebee.
      description: <p class="mb-2">Triggered when a payment source is deleted at Chargebee.</p>
      operationId: onPayment_source_locally_deletedWebhook
      requestBody:
        description: Payload for payment_source_locally_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceLocallyDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_returned:
    description: <p class="mb-2">Triggered when an order is returned.</p>
    post:
      summary: Triggered when an order is returned.
      description: <p class="mb-2">Triggered when an order is returned.</p>
      operationId: onOrder_returnedWebhook
      requestBody:
        description: Payload for order_returned event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReturnedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_deleted:
    description: <p class="mb-2">Triggered when a subscription is deleted.</p>
    post:
      summary: Triggered when a subscription is deleted.
      description: <p class="mb-2">Triggered when a subscription is deleted.</p>
      operationId: onSubscription_deletedWebhook
      requestBody:
        description: Payload for subscription_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  invoice_generated:
    description: "<p class=\"mb-2\">Event triggered when a new invoice is created\
      \ except when created with status as pending. For pending invoices, this event\
      \ is triggered when the invoice is closed.</p>"
    post:
      summary: "Event triggered when a new invoice is created except when created\
        \ with status as pending. For pending invoices, this event is triggered when\
        \ the invoice is closed."
      description: "<p class=\"mb-2\">Event triggered when a new invoice is created\
        \ except when created with status as pending. For pending invoices, this event\
        \ is triggered when the invoice is closed.</p>"
      operationId: onInvoice_generatedWebhook
      requestBody:
        description: Payload for invoice_generated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InvoiceGeneratedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  voucher_expired:
    description: <p class="mb-2">Triggered when a Payment voucher is Expired.</p>
    post:
      summary: Triggered when a Payment voucher is Expired.
      description: <p class="mb-2">Triggered when a Payment voucher is Expired.</p>
      operationId: onVoucher_expiredWebhook
      requestBody:
        description: Payload for voucher_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VoucherExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  authorization_succeeded:
    description: <p class="mb-2">Triggered when a authorization transaction is created.</p>
    post:
      summary: Triggered when a authorization transaction is created.
      description: <p class="mb-2">Triggered when a authorization transaction is created.</p>
      operationId: onAuthorization_succeededWebhook
      requestBody:
        description: Payload for authorization_succeeded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AuthorizationSucceededEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_added:
    description: <p class="mb-2">Triggered when a payment source is added.</p>
    post:
      summary: Triggered when a payment source is added.
      description: <p class="mb-2">Triggered when a payment source is added.</p>
      operationId: onPayment_source_addedWebhook
      requestBody:
        description: Payload for payment_source_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_scheduled:
    description: <p class="mb-2">Triggered when a new gift is created.</p>
    post:
      summary: Triggered when a new gift is created.
      description: <p class="mb-2">Triggered when a new gift is created.</p>
      operationId: onGift_scheduledWebhook
      requestBody:
        description: Payload for gift_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_moved_in:
    post:
      summary: Triggered when a subscription moved from other customer
      operationId: onSubscription_moved_inWebhook
      requestBody:
        description: Payload for subscription_moved_in event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionMovedInEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_changes_scheduled:
    description: <p class="mb-2">Triggered when subscription changes are scheduled
      for later. Changes will be applied at the end of current term.</p>
    post:
      summary: Triggered when subscription changes are scheduled for later. Changes
        will be applied at the end of current term.
      description: <p class="mb-2">Triggered when subscription changes are scheduled
        for later. Changes will be applied at the end of current term.</p>
      operationId: onSubscription_changes_scheduledWebhook
      requestBody:
        description: Payload for subscription_changes_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionChangesScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_changed_with_backdating:
    description: <p class="mb-2">Triggered when a subscription is changed with changes_scheduled_at
      set to a value in the past.</p>
    post:
      summary: Triggered when a subscription is changed with changes_scheduled_at
        set to a value in the past.
      description: <p class="mb-2">Triggered when a subscription is changed with changes_scheduled_at
        set to a value in the past.</p>
      operationId: onSubscription_changed_with_backdatingWebhook
      requestBody:
        description: Payload for subscription_changed_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionChangedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_cancellation_removed:
    description: <p class="mb-2">Triggered when scheduled cancellation is removed
      for the subscription.</p>
    post:
      summary: Triggered when scheduled cancellation is removed for the subscription.
      description: <p class="mb-2">Triggered when scheduled cancellation is removed
        for the subscription.</p>
      operationId: onSubscription_scheduled_cancellation_removedWebhook
      requestBody:
        description: Payload for subscription_scheduled_cancellation_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionScheduledCancellationRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_refunded:
    description: <p class="mb-2">Triggered when a payment refund is made.</p>
    post:
      summary: Triggered when a payment refund is made.
      description: <p class="mb-2">Triggered when a payment refund is made.</p>
      operationId: onPayment_refundedWebhook
      requestBody:
        description: Payload for payment_refunded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentRefundedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  usage_file_ingested:
    post:
      summary: Triggered when a usage file is ingested
      operationId: onUsage_file_ingestedWebhook
      requestBody:
        description: Payload for usage_file_ingested event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UsageFileIngestedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_unclaimed:
    description: <p class="mb-2">Triggered when a new gift is unclaimed and is ready
      to be claimed.</p>
    post:
      summary: Triggered when a new gift is unclaimed and is ready to be claimed.
      description: <p class="mb-2">Triggered when a new gift is unclaimed and is ready
        to be claimed.</p>
      operationId: onGift_unclaimedWebhook
      requestBody:
        description: Payload for gift_unclaimed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftUnclaimedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  virtual_bank_account_added:
    description: <p class="mb-2">Triggered when a virtual bank account is added.</p>
    post:
      summary: Triggered when a virtual bank account is added.
      description: <p class="mb-2">Triggered when a virtual bank account is added.</p>
      operationId: onVirtual_bank_account_addedWebhook
      requestBody:
        description: Payload for virtual_bank_account_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VirtualBankAccountAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_intent_created:
    description: <p class="mb-2">Triggered when a payment intent is created.</p>
    post:
      summary: Triggered when a payment intent is created.
      description: <p class="mb-2">Triggered when a payment intent is created.</p>
      operationId: onPayment_intent_createdWebhook
      requestBody:
        description: Payload for payment_intent_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentIntentCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_created:
    description: <p class="mb-2">Triggered when a transaction is recorded.</p>
    post:
      summary: Triggered when a transaction is recorded.
      description: <p class="mb-2">Triggered when a transaction is recorded.</p>
      operationId: onTransaction_createdWebhook
      requestBody:
        description: Payload for transaction_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransactionCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  credit_note_created_with_backdating:
    description: <p class="mb-2">Triggered when a credit note is created such that
      generated_at is a value in the past.</p>
    post:
      summary: Triggered when a credit note is created such that generated_at is a
        value in the past.
      description: <p class="mb-2">Triggered when a credit note is created such that
        generated_at is a value in the past.</p>
      operationId: onCredit_note_created_with_backdatingWebhook
      requestBody:
        description: Payload for credit_note_created_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditNoteCreatedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  contract_term_terminated:
    description: <p class="mb-2">Triggered when contract term is terminated.</p>
    post:
      summary: Triggered when contract term is terminated.
      description: <p class="mb-2">Triggered when contract term is terminated.</p>
      operationId: onContract_term_terminatedWebhook
      requestBody:
        description: Payload for contract_term_terminated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContractTermTerminatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_created:
    description: <p class="mb-2">Triggered when an order is generated.</p>
    post:
      summary: Triggered when an order is generated.
      description: <p class="mb-2">Triggered when an order is generated.</p>
      operationId: onOrder_createdWebhook
      requestBody:
        description: Payload for order_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_succeeded:
    description: <p class="mb-2">Triggered when the payment is successfully collected.</p>
    post:
      summary: Triggered when the payment is successfully collected.
      description: <p class="mb-2">Triggered when the payment is successfully collected.</p>
      operationId: onPayment_succeededWebhook
      requestBody:
        description: Payload for payment_succeeded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSucceededEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  plan_deleted:
    description: <p class="mb-2">Triggered when a plan is deleted.</p>
    post:
      summary: Triggered when a plan is deleted.
      description: <p class="mb-2">Triggered when a plan is deleted.</p>
      operationId: onPlan_deletedWebhook
      requestBody:
        description: Payload for plan_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PlanDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_canceled_with_backdating:
    description: <p class="mb-2">Triggered when a subscription is canceled with cancel_at
      set to a value in the past.</p>
    post:
      summary: Triggered when a subscription is canceled with cancel_at set to a value
        in the past.
      description: <p class="mb-2">Triggered when a subscription is canceled with
        cancel_at set to a value in the past.</p>
      operationId: onSubscription_canceled_with_backdatingWebhook
      requestBody:
        description: Payload for subscription_canceled_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCanceledWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_movement_failed:
    post:
      summary: Triggered when a subscription movement failed
      operationId: onSubscription_movement_failedWebhook
      requestBody:
        description: Payload for subscription_movement_failed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionMovementFailedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  unbilled_charges_voided:
    description: <p class="mb-2">Triggered when unbilled charges are voided</p>
    post:
      summary: Triggered when unbilled charges are voided
      description: <p class="mb-2">Triggered when unbilled charges are voided</p>
      operationId: onUnbilled_charges_voidedWebhook
      requestBody:
        description: Payload for unbilled_charges_voided event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UnbilledChargesVoidedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  quote_created:
    description: <p class="mb-2">Event triggered when a new quote is generated.</p>
    post:
      summary: Event triggered when a new quote is generated.
      description: <p class="mb-2">Event triggered when a new quote is generated.</p>
      operationId: onQuote_createdWebhook
      requestBody:
        description: Payload for quote_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QuoteCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_moved_in:
    description: <p class="mb-2">Triggered when a customer is copied from another
      site.</p>
    post:
      summary: Triggered when a customer is copied from another site.
      description: <p class="mb-2">Triggered when a customer is copied from another
        site.</p>
      operationId: onCustomer_moved_inWebhook
      requestBody:
        description: Payload for customer_moved_in event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerMovedInEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_set_deleted:
    description: <p class="mb-2">Triggered when a coupon set is deleted.</p>
    post:
      summary: Triggered when a coupon set is deleted.
      description: <p class="mb-2">Triggered when a coupon set is deleted.</p>
      operationId: onCoupon_set_deletedWebhook
      requestBody:
        description: Payload for coupon_set_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponSetDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_advance_invoice_schedule_updated:
    description: <p class="mb-2">Triggered when scheduled advance invoice is updated
      for a subscription.</p>
    post:
      summary: Triggered when scheduled advance invoice is updated for a subscription.
      description: <p class="mb-2">Triggered when scheduled advance invoice is updated
        for a subscription.</p>
      operationId: onSubscription_advance_invoice_schedule_updatedWebhook
      requestBody:
        description: Payload for subscription_advance_invoice_schedule_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionAdvanceInvoiceScheduleUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_changed:
    description: <p class="mb-2">Triggered when a customer is changed.</p>
    post:
      summary: Triggered when a customer is changed.
      description: <p class="mb-2">Triggered when a customer is changed.</p>
      operationId: onCustomer_changedWebhook
      requestBody:
        description: Payload for customer_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_started:
    description: <p class="mb-2">Triggered when a &#x27;future&#x27; subscription
      gets started.</p>
    post:
      summary: Triggered when a 'future' subscription gets started.
      description: <p class="mb-2">Triggered when a &#x27;future&#x27; subscription
        gets started.</p>
      operationId: onSubscription_startedWebhook
      requestBody:
        description: Payload for subscription_started event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionStartedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_activated:
    description: <p class="mb-2">Triggered after the subscription has been moved from
      &quot;Trial&quot; to &quot;Active&quot; state.</p>
    post:
      summary: Triggered after the subscription has been moved from "Trial" to "Active"
        state.
      description: <p class="mb-2">Triggered after the subscription has been moved
        from &quot;Trial&quot; to &quot;Active&quot; state.</p>
      operationId: onSubscription_activatedWebhook
      requestBody:
        description: Payload for subscription_activated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionActivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_expiring:
    description: <p class="mb-2">Triggered when the customer&#x27;s payment source
      is expiring soon. Triggered 30 days before the expiry date.</p>
    post:
      summary: Triggered when the customer's payment source is expiring soon. Triggered
        30 days before the expiry date.
      description: <p class="mb-2">Triggered when the customer&#x27;s payment source
        is expiring soon. Triggered 30 days before the expiry date.</p>
      operationId: onPayment_source_expiringWebhook
      requestBody:
        description: Payload for payment_source_expiring event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceExpiringEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_reactivated:
    description: <p class="mb-2">Triggered when the subscription is moved from <code
      class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
      px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code> <code
      class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
      px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> to <code
      class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
      px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code
      class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
      px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>.</p>
    post:
      summary: Triggered when the subscription is moved from `cancelled` `status`
        to `active` or `in_trial`.
      description: <p class="mb-2">Triggered when the subscription is moved from <code
        class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
        px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">cancelled</code> <code
        class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
        px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> to <code
        class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
        px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active</code> or <code
        class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded
        px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code>.</p>
      operationId: onSubscription_reactivatedWebhook
      requestBody:
        description: Payload for subscription_reactivated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionReactivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_updated:
    description: <p class="mb-2">Triggered when an order is updated.</p>
    post:
      summary: Triggered when an order is updated.
      description: <p class="mb-2">Triggered when an order is updated.</p>
      operationId: onOrder_updatedWebhook
      requestBody:
        description: Payload for order_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_pause_removed:
    description: <p class="mb-2">Triggered when scheduled pause is removed for the
      subscription.</p>
    post:
      summary: Triggered when scheduled pause is removed for the subscription.
      description: <p class="mb-2">Triggered when scheduled pause is removed for the
        subscription.</p>
      operationId: onSubscription_scheduled_pause_removedWebhook
      requestBody:
        description: Payload for subscription_scheduled_pause_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionScheduledPauseRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_cancellation_reminder:
    description: <p class="mb-2">Triggered 6 days prior to the scheduled cancellation
      date.</p>
    post:
      summary: Triggered 6 days prior to the scheduled cancellation date.
      description: <p class="mb-2">Triggered 6 days prior to the scheduled cancellation
        date.</p>
      operationId: onSubscription_cancellation_reminderWebhook
      requestBody:
        description: Payload for subscription_cancellation_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCancellationReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  dunning_updated:
    post:
      summary: Triggered when dunning is paused for an invoice
      operationId: onDunning_updatedWebhook
      requestBody:
        description: Payload for dunning_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DunningUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  addon_deleted:
    description: <p class="mb-2">Triggered when an addon is deleted.</p>
    post:
      summary: Triggered when an addon is deleted.
      description: <p class="mb-2">Triggered when an addon is deleted.</p>
      operationId: onAddon_deletedWebhook
      requestBody:
        description: Payload for addon_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddonDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_created_with_backdating:
    description: <p class="mb-2">Triggered when a subscription is created and the
      value of subscription.started_at is in the past.</p>
    post:
      summary: Triggered when a subscription is created and the value of subscription.started_at
        is in the past.
      description: <p class="mb-2">Triggered when a subscription is created and the
        value of subscription.started_at is in the past.</p>
      operationId: onSubscription_created_with_backdatingWebhook
      requestBody:
        description: Payload for subscription_created_with_backdating event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCreatedWithBackdatingEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_deleted:
    description: <p class="mb-2">Triggered when an order is deleted.</p>
    post:
      summary: Triggered when an order is deleted.
      description: <p class="mb-2">Triggered when an order is deleted.</p>
      operationId: onOrder_deletedWebhook
      requestBody:
        description: Payload for order_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  token_consumed:
    description: <p class="mb-2">Triggered when a nonce is consumed.</p>
    post:
      summary: Triggered when a nonce is consumed.
      description: <p class="mb-2">Triggered when a nonce is consumed.</p>
      operationId: onToken_consumedWebhook
      requestBody:
        description: Payload for token_consumed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TokenConsumedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  addon_updated:
    description: <p class="mb-2">Triggered when an addon is changed.</p>
    post:
      summary: Triggered when an addon is changed.
      description: <p class="mb-2">Triggered when an addon is changed.</p>
      operationId: onAddon_updatedWebhook
      requestBody:
        description: Payload for addon_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddonUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  hierarchy_deleted:
    description: <p class="mb-2">Triggered when a hierarchy is deleted.</p>
    post:
      summary: Triggered when a hierarchy is deleted.
      description: <p class="mb-2">Triggered when a hierarchy is deleted.</p>
      operationId: onHierarchy_deletedWebhook
      requestBody:
        description: Payload for hierarchy_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HierarchyDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_cancellation_scheduled:
    description: <p class="mb-2">Triggered when subscription is scheduled to cancel
      at end of current term.</p>
    post:
      summary: Triggered when subscription is scheduled to cancel at end of current
        term.
      description: <p class="mb-2">Triggered when subscription is scheduled to cancel
        at end of current term.</p>
      operationId: onSubscription_cancellation_scheduledWebhook
      requestBody:
        description: Payload for subscription_cancellation_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionCancellationScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_updated:
    description: <p class="mb-2">Triggered when a gift is updated.</p>
    post:
      summary: Triggered when a gift is updated.
      description: <p class="mb-2">Triggered when a gift is updated.</p>
      operationId: onGift_updatedWebhook
      requestBody:
        description: Payload for gift_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GiftUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_trial_extended:
    description: <p class="mb-2">Trial Extension</p>
    post:
      summary: Trial Extension
      description: <p class="mb-2">Trial Extension</p>
      operationId: onSubscription_trial_extendedWebhook
      requestBody:
        description: Payload for subscription_trial_extended event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionTrialExtendedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_renewed:
    description: <p class="mb-2">Triggered when the subscription is renewed from the
      current term.</p>
    post:
      summary: Triggered when the subscription is renewed from the current term.
      description: <p class="mb-2">Triggered when the subscription is renewed from
        the current term.</p>
      operationId: onSubscription_renewedWebhook
      requestBody:
        description: Payload for subscription_renewed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRenewedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  addon_created:
    description: <p class="mb-2">Triggered when an addon is created.</p>
    post:
      summary: Triggered when an addon is created.
      description: <p class="mb-2">Triggered when an addon is created.</p>
      operationId: onAddon_createdWebhook
      requestBody:
        description: Payload for addon_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddonCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_expiry_reminder:
    description: <p class="mb-2">Triggered when the customer&#x27;s credit card is
      expiring soon. Triggered 30 days before the expiry date.</p>
    post:
      summary: Triggered when the customer's credit card is expiring soon. Triggered
        30 days before the expiry date.
      description: <p class="mb-2">Triggered when the customer&#x27;s credit card
        is expiring soon. Triggered 30 days before the expiry date.</p>
      operationId: onCard_expiry_reminderWebhook
      requestBody:
        description: Payload for card_expiry_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CardExpiryReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  token_created:
    description: <p class="mb-2">Triggered when a nonce is created.</p>
    post:
      summary: Triggered when a nonce is created.
      description: <p class="mb-2">Triggered when a nonce is created.</p>
      operationId: onToken_createdWebhook
      requestBody:
        description: Payload for token_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TokenCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  plan_created:
    description: <p class="mb-2">Triggered when a plan is created.</p>
    post:
      summary: Triggered when a plan is created.
      description: <p class="mb-2">Triggered when a plan is created.</p>
      operationId: onPlan_createdWebhook
      requestBody:
        description: Payload for plan_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PlanCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  plan_updated:
    description: <p class="mb-2">Triggered when a plan is changed.</p>
    post:
      summary: Triggered when a plan is changed.
      description: <p class="mb-2">Triggered when a plan is changed.</p>
      operationId: onPlan_updatedWebhook
      requestBody:
        description: Payload for plan_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PlanUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  promotional_credits_added:
    description: <p class="mb-2">Triggered when promotional credit is added.</p>
    post:
      summary: Triggered when promotional credit is added.
      description: <p class="mb-2">Triggered when promotional credit is added.</p>
      operationId: onPromotional_credits_addedWebhook
      requestBody:
        description: Payload for promotional_credits_added event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PromotionalCreditsAddedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_resumption_scheduled:
    description: <p class="mb-2">Triggered when the subscription is scheduled to resume.</p>
    post:
      summary: Triggered when the subscription is scheduled to resume.
      description: <p class="mb-2">Triggered when the subscription is scheduled to
        resume.</p>
      operationId: onSubscription_resumption_scheduledWebhook
      requestBody:
        description: Payload for subscription_resumption_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionResumptionScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_deleted:
    description: <p class="mb-2">Triggered when coupon codes are deleted in coupon
      set.</p>
    post:
      summary: Triggered when coupon codes are deleted in coupon set.
      description: <p class="mb-2">Triggered when coupon codes are deleted in coupon
        set.</p>
      operationId: onCoupon_codes_deletedWebhook
      requestBody:
        description: Payload for coupon_codes_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponCodesDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_expired:
    description: <p class="mb-2">Triggered when the card for a customer has expired.</p>
    post:
      summary: Triggered when the card for a customer has expired.
      description: <p class="mb-2">Triggered when the card for a customer has expired.</p>
      operationId: onCard_expiredWebhook
      requestBody:
        description: Payload for card_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CardExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  credit_note_updated:
    description: <p class="mb-2">Triggered when a credit note is updated.</p>
    post:
      summary: Triggered when a credit note is updated.
      description: <p class="mb-2">Triggered when a credit note is updated.</p>
      operationId: onCredit_note_updatedWebhook
      requestBody:
        description: Payload for credit_note_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditNoteUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  promotional_credits_deducted:
    description: <p class="mb-2">Triggered when promotional credit is deducted.</p>
    post:
      summary: Triggered when promotional credit is deducted.
      description: <p class="mb-2">Triggered when promotional credit is deducted.</p>
      operationId: onPromotional_credits_deductedWebhook
      requestBody:
        description: Payload for promotional_credits_deducted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PromotionalCreditsDeductedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_expired:
    description: <p class="mb-2">Triggered when the payment source for a customer
      has expired.</p>
    post:
      summary: Triggered when the payment source for a customer has expired.
      description: <p class="mb-2">Triggered when the payment source for a customer
        has expired.</p>
      operationId: onPayment_source_expiredWebhook
      requestBody:
        description: Payload for payment_source_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_moved_out:
    description: <p class="mb-2">Triggered when a customer is copied to another site.</p>
    post:
      summary: Triggered when a customer is copied to another site.
      description: <p class="mb-2">Triggered when a customer is copied to another
        site.</p>
      operationId: onCustomer_moved_outWebhook
      requestBody:
        description: Payload for customer_moved_out event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerMovedOutEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_paused:
    description: <p class="mb-2">Triggered when the subscription is paused.</p>
    post:
      summary: Triggered when the subscription is paused.
      description: <p class="mb-2">Triggered when the subscription is paused.</p>
      operationId: onSubscription_pausedWebhook
      requestBody:
        description: Payload for subscription_paused event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionPausedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_ready_to_process:
    description: <p class="mb-2">Triggered when an order reaches it&#x27;s order date.</p>
    post:
      summary: Triggered when an order reaches it's order date.
      description: <p class="mb-2">Triggered when an order reaches it&#x27;s order
        date.</p>
      operationId: onOrder_ready_to_processWebhook
      requestBody:
        description: Payload for order_ready_to_process event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReadyToProcessEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  hierarchy_created:
    description: <p class="mb-2">Triggered when a hierarchy is created.</p>
    post:
      summary: Triggered when a hierarchy is created.
      description: <p class="mb-2">Triggered when a hierarchy is created.</p>
      operationId: onHierarchy_createdWebhook
      requestBody:
        description: Payload for hierarchy_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HierarchyCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_deleted:
    description: <p class="mb-2">Triggered when a transaction is deleted.</p>
    post:
      summary: Triggered when a transaction is deleted.
      description: <p class="mb-2">Triggered when a transaction is deleted.</p>
      operationId: onTransaction_deletedWebhook
      requestBody:
        description: Payload for transaction_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransactionDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  credit_note_created:
    description: <p class="mb-2">Triggered when a credit note is created.</p>
    post:
      summary: Triggered when a credit note is created.
      description: <p class="mb-2">Triggered when a credit note is created.</p>
      operationId: onCredit_note_createdWebhook
      requestBody:
        description: Payload for credit_note_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditNoteCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_set_created:
    description: <p class="mb-2">Triggered when a coupon set is created.</p>
    post:
      summary: Triggered when a coupon set is created.
      description: <p class="mb-2">Triggered when a coupon set is created.</p>
      operationId: onCoupon_set_createdWebhook
      requestBody:
        description: Payload for coupon_set_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponSetCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_updated:
    description: "<p class=\"mb-2\">Triggered when a transaction is updated. E.g.\
      \ (1) When a transaction is removed, (2) or when an excess payment is applied\
      \ on an invoice, (3) or when amount_capturable gets updated.</p>"
    post:
      summary: "Triggered when a transaction is updated. E.g. (1) When a transaction\
        \ is removed, (2) or when an excess payment is applied on an invoice, (3)\
        \ or when amount_capturable gets updated."
      description: "<p class=\"mb-2\">Triggered when a transaction is updated. E.g.\
        \ (1) When a transaction is removed, (2) or when an excess payment is applied\
        \ on an invoice, (3) or when amount_capturable gets updated.</p>"
      operationId: onTransaction_updatedWebhook
      requestBody:
        description: Payload for transaction_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransactionUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_intent_updated:
    description: <p class="mb-2">Triggered when a payment intent is updated.</p>
    post:
      summary: Triggered when a payment intent is updated.
      description: <p class="mb-2">Triggered when a payment intent is updated.</p>
      operationId: onPayment_intent_updatedWebhook
      requestBody:
        description: Payload for payment_intent_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentIntentUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  mrr_updated:
    description: <p class="mb-2">Triggered when either of MRR or CMRR is changed.</p>
    post:
      summary: Triggered when either of MRR or CMRR is changed.
      description: <p class="mb-2">Triggered when either of MRR or CMRR is changed.</p>
      operationId: onMrr_updatedWebhook
      requestBody:
        description: Payload for mrr_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MrrUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_resent:
    description: <p class="mb-2">Triggered when an order is resent.</p>
    post:
      summary: Triggered when an order is resent.
      description: <p class="mb-2">Triggered when an order is resent.</p>
      operationId: onOrder_resentWebhook
      requestBody:
        description: Payload for order_resent event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderResentEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  unbilled_charges_invoiced:
    description: <p class="mb-2">Triggered when unbilled charges are invoiced</p>
    post:
      summary: Triggered when unbilled charges are invoiced
      description: <p class="mb-2">Triggered when unbilled charges are invoiced</p>
      operationId: onUnbilled_charges_invoicedWebhook
      requestBody:
        description: Payload for unbilled_charges_invoiced event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UnbilledChargesInvoicedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  tax_withheld_recorded:
    description: <p class="mb-2">Triggered when a tax withheld is recorded for an
      invoice.</p>
    post:
      summary: Triggered when a tax withheld is recorded for an invoice.
      description: <p class="mb-2">Triggered when a tax withheld is recorded for an
        invoice.</p>
      operationId: onTax_withheld_recordedWebhook
      requestBody:
        description: Payload for tax_withheld_recorded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TaxWithheldRecordedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_updated:
    description: <p class="mb-2">Triggered when coupon codes are updated in coupon
      set.</p>
    post:
      summary: Triggered when coupon codes are updated in coupon set.
      description: <p class="mb-2">Triggered when coupon codes are updated in coupon
        set.</p>
      operationId: onCoupon_codes_updatedWebhook
      requestBody:
        description: Payload for coupon_codes_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CouponCodesUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  virtual_bank_account_updated:
    description: <p class="mb-2">Triggered when the virtual bank account is updated.</p>
    post:
      summary: Triggered when the virtual bank account is updated.
      description: <p class="mb-2">Triggered when the virtual bank account is updated.</p>
      operationId: onVirtual_bank_account_updatedWebhook
      requestBody:
        description: Payload for virtual_bank_account_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VirtualBankAccountUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  contract_term_created:
    description: <p class="mb-2">Triggered when contract term is created.</p>
    post:
      summary: Triggered when contract term is created.
      description: <p class="mb-2">Triggered when contract term is created.</p>
      operationId: onContract_term_createdWebhook
      requestBody:
        description: Payload for contract_term_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContractTermCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_changed:
    description: <p class="mb-2">Triggered when the subscription&#x27;s recurring
      items are changed.</p>
    post:
      summary: Triggered when the subscription's recurring items are changed.
      description: <p class="mb-2">Triggered when the subscription&#x27;s recurring
        items are changed.</p>
      operationId: onSubscription_changedWebhook
      requestBody:
        description: Payload for subscription_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_items_renewed:
    post:
      summary: Triggered when one or more Subscription Items are renewed
      operationId: onSubscription_items_renewedWebhook
      requestBody:
        description: Payload for subscription_items_renewed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionItemsRenewedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  rule_created:
    post:
      summary: Triggered when a rule is created
      operationId: onRule_createdWebhook
      requestBody:
        description: Payload for rule_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RuleCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  contract_term_cancelled:
    description: <p class="mb-2">Triggered when contract term is cancelled.</p>
    post:
      summary: Triggered when contract term is cancelled.
      description: <p class="mb-2">Triggered when contract term is cancelled.</p>
      operationId: onContract_term_cancelledWebhook
      requestBody:
        description: Payload for contract_term_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContractTermCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  contract_term_renewed:
    description: <p class="mb-2">Triggered when a contract term is renewed.</p>
    post:
      summary: Triggered when a contract term is renewed.
      description: <p class="mb-2">Triggered when a contract term is renewed.</p>
      operationId: onContract_term_renewedWebhook
      requestBody:
        description: Payload for contract_term_renewed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContractTermRenewedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  invoice_deleted:
    description: <p class="mb-2">Event triggered when an invoice is deleted.</p>
    post:
      summary: Event triggered when an invoice is deleted.
      description: <p class="mb-2">Event triggered when an invoice is deleted.</p>
      operationId: onInvoice_deletedWebhook
      requestBody:
        description: Payload for invoice_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InvoiceDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_failed:
    description: <p class="mb-2">Triggered when the payment collection fails.</p>
    post:
      summary: Triggered when the payment collection fails.
      description: <p class="mb-2">Triggered when the payment collection fails.</p>
      operationId: onPayment_failedWebhook
      requestBody:
        description: Payload for payment_failed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentFailedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  credit_note_deleted:
    description: <p class="mb-2">Triggered when a credit note is deleted.</p>
    post:
      summary: Triggered when a credit note is deleted.
      description: <p class="mb-2">Triggered when a credit note is deleted.</p>
      operationId: onCredit_note_deletedWebhook
      requestBody:
        description: Payload for credit_note_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditNoteDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  tax_withheld_refunded:
    description: <p class="mb-2">Triggered when a tax withheld is refunded.</p>
    post:
      summary: Triggered when a tax withheld is refunded.
      description: <p class="mb-2">Triggered when a tax withheld is refunded.</p>
      operationId: onTax_withheld_refundedWebhook
      requestBody:
        description: Payload for tax_withheld_refunded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TaxWithheldRefundedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  contract_term_completed:
    description: <p class="mb-2">Triggered when contract term is completed.</p>
    post:
      summary: Triggered when contract term is completed.
      description: <p class="mb-2">Triggered when contract term is completed.</p>
      operationId: onContract_term_completedWebhook
      requestBody:
        description: Payload for contract_term_completed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContractTermCompletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_updated:
    description: <p class="mb-2">Triggered when the card is updated for a customer.</p>
    post:
      summary: Triggered when the card is updated for a customer.
      description: <p class="mb-2">Triggered when the card is updated for a customer.</p>
      operationId: onCard_updatedWebhook
      requestBody:
        description: Payload for card_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CardUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_created:
    description: <p class="mb-2">Triggered when a customer is created.</p>
    post:
      summary: Triggered when a customer is created.
      description: <p class="mb-2">Triggered when a customer is created.</p>
      operationId: onCustomer_createdWebhook
      requestBody:
        description: Payload for customer_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  pending_invoice_updated:
    description: "<p class=\"mb-2\">Triggered when you make the following changes\
      \ to the invoice - void, delete, invoice address update, status change, payment\
      \ changes - apply payment / remove payment, credit apply/remove, credit note\
      \ creation, and so on. &#x27;Invoice_updated&#x27; is triggered for all changes\
      \ made to the invoice except for the changes which trigger &#x27;pending_invoice_updated&#x27;.</p>"
    post:
      summary: "Triggered when you make the following changes to the invoice - void,\
        \ delete, invoice address update, status change, payment changes - apply payment\
        \ / remove payment, credit apply/remove, credit note creation, and so on.\
        \ 'Invoice_updated' is triggered for all changes made to the invoice except\
        \ for the changes which trigger 'pending_invoice_updated'."
      description: "<p class=\"mb-2\">Triggered when you make the following changes\
        \ to the invoice - void, delete, invoice address update, status change, payment\
        \ changes - apply payment / remove payment, credit apply/remove, credit note\
        \ creation, and so on. &#x27;Invoice_updated&#x27; is triggered for all changes\
        \ made to the invoice except for the changes which trigger &#x27;pending_invoice_updated&#x27;.</p>"
      operationId: onPending_invoice_updatedWebhook
      requestBody:
        description: Payload for pending_invoice_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PendingInvoiceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  quote_updated:
    description: <p class="mb-2">Triggered when a quote is updated.</p>
    post:
      summary: Triggered when a quote is updated.
      description: <p class="mb-2">Triggered when a quote is updated.</p>
      operationId: onQuote_updatedWebhook
      requestBody:
        description: Payload for quote_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QuoteUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_renewal_reminder:
    description: <p class="mb-2">Triggered 3 days before each subscription&#x27;s
      renewal.</p>
    post:
      summary: Triggered 3 days before each subscription's renewal.
      description: <p class="mb-2">Triggered 3 days before each subscription&#x27;s
        renewal.</p>
      operationId: onSubscription_renewal_reminderWebhook
      requestBody:
        description: Payload for subscription_renewal_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRenewalReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_updated:
    description: <p class="mb-2">Triggered when the payment source is updated and
      also when a role is assigned to it.</p>
    post:
      summary: Triggered when the payment source is updated and also when a role is
        assigned to it.
      description: <p class="mb-2">Triggered when the payment source is updated and
        also when a role is assigned to it.</p>
      operationId: onPayment_source_updatedWebhook
      requestBody:
        description: Payload for payment_source_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  authorization_voided:
    description: <p class="mb-2">Triggered when a authorization transaction is voided.
      Authorization can be voided either manually or when blocked funds are released
      by the gateway after a certain period of time.</p>
    post:
      summary: Triggered when a authorization transaction is voided. Authorization
        can be voided either manually or when blocked funds are released by the gateway
        after a certain period of time.
      description: <p class="mb-2">Triggered when a authorization transaction is voided.
        Authorization can be voided either manually or when blocked funds are released
        by the gateway after a certain period of time.</p>
      operationId: onAuthorization_voidedWebhook
      requestBody:
        description: Payload for authorization_voided event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AuthorizationVoidedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
